EventWaitHandle.TryOpenExisting Метод

Определение

Пространство имен:

System.Threading

Сборка:

System.Threading.dll

Открывает указанное именованное событие синхронизации, если оно уже существует, и возвращает значение, указывающее, успешно ли выполнена операция.

Перегрузки

TryOpenExisting(String, EventWaitHandle)

Открывает указанное именованное событие синхронизации, если оно уже существует, и возвращает значение, указывающее, успешно ли выполнена операция.

TryOpenExisting(String, EventWaitHandle)

Исходный код:

EventWaitHandle.cs

Открывает указанное именованное событие синхронизации, если оно уже существует, и возвращает значение, указывающее, успешно ли выполнена операция.

public:
 static bool TryOpenExisting(System::String ^ name, [Runtime::InteropServices::Out] System::Threading::EventWaitHandle ^ % result);

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static bool TryOpenExisting (string name, out System.Threading.EventWaitHandle? result);

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member TryOpenExisting : string * EventWaitHandle -> bool

Public Shared Function TryOpenExisting (name As String, ByRef result As EventWaitHandle) As Boolean

Параметры

name

String

Имя объекта синхронизации, который должен быть открыт для других процессов и использоваться совместно с этими процессами. Имя указано с учетом регистра. Символ обратной косой черты (\) зарезервирован и может использоваться только для указания пространства имен. Дополнительные сведения о пространствах имен см. в разделе примечаний. В зависимости от операционной системы могут существовать дополнительные ограничения на имя. Например, в операционных системах под управлением Unix имя после исключения пространства имен должно быть допустимым именем файла.

result

EventWaitHandle

При возврате этого метода содержит объект EventWaitHandle, представляющий именованное событие синхронизации, если вызов завершился успешно, или значение null, если вызов завершился неудачно. Этот параметр обрабатывается как неинициализированный.

Возвращаемое значение

Boolean

Значение true, если именованное событие синхронизации открылось успешно. В противном случае — значение false. В некоторых случаях false может возвращаться для недопустимых имен.

Атрибуты

SupportedOSPlatformAttribute

Исключения

ArgumentException

Параметр name равен пустой строке.

- или -

Только в .NET Framework. name превышает значение MAX_PATH (260 символов).

ArgumentNullException

name имеет значение null.

IOException

name недопустим. Это исключение может возникнуть по разным причинам, включая некоторые ограничения, установленные операционной системой (например, в отношении использования неизвестных префиксов или недопустимых символов). Обратите внимание, что в имени и общих префиксах Global\" и "Local\" учитывается регистр. Для некоторых недопустимых имен метод может возвращать false.

- или -

Произошла другая ошибка. Дополнительные сведения можно получить с помощью свойства HResult.

PathTooLongException

Слишком длинное значение name. Ограничения длины могут зависеть от операционной системы или конфигурации.

UnauthorizedAccessException

Именованное событие уже существует, но пользователь не имеет требуемых прав для безопасного доступа.

Комментарии

Может name иметь префикс Global\ или Local\ , чтобы указать пространство имен. Global Если указано пространство имен, объект синхронизации может быть совместно использоваться любым процессам в системе. Local Если задано пространство имен, которое также используется по умолчанию, если пространство имен не указано, объект синхронизации может быть совместно использоваться процессами в одном сеансе. В Windows сеанс является сеансом входа, а службы обычно выполняются в другом неинтерактивном сеансе. В unix-подобных операционных системах каждая оболочка имеет собственный сеанс. Объекты локальной синхронизации сеанса могут подходить для синхронизации между процессами с отношением "родители-потомки", где все они выполняются в одном сеансе. Дополнительные сведения об именах объектов синхронизации в Windows см. в разделе Имена объектов.

Если объект синхронизации запрошенного типа существует в пространстве имен, открывается существующий объект синхронизации. Если объект синхронизации не существует в пространстве имен или объект синхронизации другого типа существует в пространстве имен, false возвращается .

Чтобы создать системное событие, если оно еще не существует, используйте один из EventWaitHandle конструкторов с параметром name .

Если вы не уверены, существует ли именованное событие синхронизации, используйте эту перегрузку OpenExisting(String) метода вместо перегрузки метода, которая создает исключение, если событие синхронизации не существует.

Эта перегрузка метода эквивалентна вызову перегрузки TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle) метода и указанию EventWaitHandleRights.Synchronize прав и EventWaitHandleRights.Modify , объединенных с помощью побитовой операции OR. Указание флага EventWaitHandleRights.Synchronize позволяет потоку ждать именованного системного события, а указание EventWaitHandleRights.Modify флага позволяет потоку вызывать Set методы и Reset .

Несколько вызовов этого метода, использующих одно и то же значение для , name не обязательно возвращают один и тот же EventWaitHandle объект, даже если возвращаемые объекты представляют одно и то же именованное системное событие.