Mutex.TryOpenExisting Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Se um mutex nomeado especificado já existe, abre-o e retorna um valor que indica se a operação foi bem-sucedida.
Sobrecargas
| TryOpenExisting(String, Mutex) |
Abre o mutex nomeado especificado, quando ele já existe e retorna um valor que indica se a operação foi bem-sucedida. |
| TryOpenExisting(String, MutexRights, Mutex) |
Se o mutex nomeado especificado já existe, abre-o com o acesso de segurança desejado e retorna um valor que indica se a operação foi bem-sucedida. |
TryOpenExisting(String, Mutex)
Abre o mutex nomeado especificado, quando ele já existe e retorna um valor que indica se a operação foi bem-sucedida.
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 -> boolstatic member TryOpenExisting : string * Mutex -> boolPublic Shared Function TryOpenExisting (name As String, ByRef result As Mutex) As BooleanParâmetros
- name
- String
O nome do objeto de sincronização a ser compartilhado com outros processos. O nome diferencia maiúsculas de minúsculas.
- result
- Mutex
Quando este método retorna, ele contém um objeto Mutex que representa o mutex nomeado se a chamada foi bem-sucedida ou null se a chamada falhou. Esse parâmetro é tratado como não inicializado.
Retornos
true se o mutex nomeado foi aberto com sucesso, caso contrário, false. Em alguns casos, false pode ser retornado para nomes inválidos.
- Atributos
Exceções
name é uma cadeia de caracteres vazia.
- ou -
Somente .NET Framework: name é maior que MAX_PATH (260 caracteres).
name é null.
name é inválido. Isso pode ser por vários motivos, incluindo algumas restrições impostas pelo sistema operacional, como um prefixo desconhecido ou caracteres inválidos. Observe que o nome e os prefixos comuns "Global" e "Local" diferenciam maiúsculas de minúsculas. Para alguns nomes inválidos, o método pode retornar false em vez disso.
- ou -
Ocorreu outro erro. A propriedade HResult pode fornecer mais informações.
O name é muito longo. As restrições de comprimento podem depender do sistema operacional ou da configuração.
O mutex nomeado existe, mas o usuário não tem o acesso de segurança necessário para usá-lo.
Comentários
Pode name ser prefixado com Global\ ou Local\ especificar um namespace. Quando o Global namespace é especificado, o objeto de sincronização pode ser compartilhado com todos os processos no sistema. Quando o Local namespace é especificado, que também é o padrão quando nenhum namespace é especificado, o objeto de sincronização pode ser compartilhado com processos na mesma sessão. No Windows, uma sessão é uma sessão de logon e os serviços normalmente são executados em uma sessão não interativa diferente. Em sistemas operacionais semelhantes ao Unix, cada shell tem sua própria sessão. Objetos de sincronização local de sessão podem ser apropriados para sincronizar entre processos com uma relação pai/filho em que todos eles são executados na mesma sessão. Para obter mais informações sobre nomes de objetos de sincronização em Windows, consulte Nomes de Objeto.
Se existir um objeto de sincronização do tipo solicitado no namespace, o objeto de sincronização existente será aberto. Se um objeto de sincronização não existir no namespace ou um objeto de sincronização de um tipo diferente existir no namespace, false será retornado.
Para criar o mutex do sistema quando ele ainda não existir, use um dos Mutex construtores que tem um name parâmetro.
Se você não tiver certeza se existe um mutex nomeado, use essa sobrecarga de método em vez da sobrecarga do método, o OpenExisting(String) que gera uma exceção se o mutex não existir.
Várias chamadas para esse método que usam o mesmo valor name não necessariamente retornam o mesmo Mutex objeto, embora os objetos retornados representem o mesmo mutex do sistema nomeado.
Essa sobrecarga de método é equivalente a chamar a sobrecarga do TryOpenExisting(String, MutexRights, Mutex) método e especificar MutexRights.Synchronize e MutexRights.Modify os direitos, combinados usando a operação OR bit a bit. Especificar o MutexRights.Synchronize sinalizador permite que um thread aguarde no mutex e especificar o MutexRights.Modify sinalizador permite que um thread chame o ReleaseMutex método.
Esse método não solicita a propriedade do mutex.
Aplica-se a
TryOpenExisting(String, MutexRights, Mutex)
Se o mutex nomeado especificado já existe, abre-o com o acesso de segurança desejado e retorna um valor que indica se a operação foi bem-sucedida.
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);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 -> boolstatic member TryOpenExisting : string * System.Security.AccessControl.MutexRights * Mutex -> boolPublic Shared Function TryOpenExisting (name As String, rights As MutexRights, ByRef result As Mutex) As BooleanParâmetros
- name
- String
O nome do objeto de sincronização a ser compartilhado com outros processos. O nome diferencia maiúsculas de minúsculas.
- rights
- MutexRights
Uma combinação bit a bit dos valores de enumeração que representa o acesso de segurança desejado.
- result
- Mutex
Quando este método retorna, ele contém um objeto Mutex que representa o mutex nomeado se a chamada foi bem-sucedida ou null se a chamada falhou. Esse parâmetro é tratado como não inicializado.
Retornos
true se o mutex nomeado foi aberto com sucesso, caso contrário, false. Em alguns casos, false pode ser retornado para nomes inválidos.
- Atributos
Exceções
name é uma cadeia de caracteres vazia.
- ou -
Somente .NET Framework: name é maior que MAX_PATH (260 caracteres).
name é null.
name é inválido. Isso pode ser por vários motivos, incluindo algumas restrições impostas pelo sistema operacional, como um prefixo desconhecido ou caracteres inválidos. Observe que o nome e os prefixos comuns "Global" e "Local" diferenciam maiúsculas de minúsculas. Para alguns nomes inválidos, o método pode retornar false em vez disso.
- ou -
Ocorreu outro erro. A propriedade HResult pode fornecer mais informações.
O name é muito longo. As restrições de comprimento podem depender do sistema operacional ou da configuração.
O mutex nomeado existe, mas o usuário não tem o acesso de segurança necessário para usá-lo.
Comentários
Pode name ser prefixado com Global\ ou Local\ especificar um namespace. Quando o Global namespace é especificado, o objeto de sincronização pode ser compartilhado com todos os processos no sistema. Quando o Local namespace é especificado, que também é o padrão quando nenhum namespace é especificado, o objeto de sincronização pode ser compartilhado com processos na mesma sessão. No Windows, uma sessão é uma sessão de logon e os serviços normalmente são executados em uma sessão não interativa diferente. Em sistemas operacionais semelhantes ao Unix, cada shell tem sua própria sessão. Objetos de sincronização local de sessão podem ser apropriados para sincronizar entre processos com uma relação pai/filho em que todos eles são executados na mesma sessão. Para obter mais informações sobre nomes de objetos de sincronização em Windows, consulte Nomes de Objeto.
Se existir um objeto de sincronização do tipo solicitado no namespace, o objeto de sincronização existente será aberto. Se um objeto de sincronização não existir no namespace ou um objeto de sincronização de um tipo diferente existir no namespace, false será retornado.
Para criar o mutex do sistema quando ele ainda não existir, use um dos Mutex construtores que tem um name parâmetro.
Se você não tiver certeza se existe um mutex nomeado, use essa sobrecarga de método em vez da sobrecarga do método, o OpenExisting(String, MutexRights) que gera uma exceção se o mutex não existir.
O rights parâmetro deve incluir o MutexRights.Synchronize sinalizador para permitir que os threads aguardem no mutex e o MutexRights.Modify sinalizador para permitir que os threads chamem o ReleaseMutex método.
Várias chamadas para esse método que usam o mesmo valor name não necessariamente retornam o mesmo Mutex objeto, embora os objetos retornados representem o mesmo mutex do sistema nomeado.
Esse método não solicita a propriedade do mutex.