Semaphore.TryOpenExisting メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
既に存在する場合は、指定した名前付きセマフォを開き操作が成功したかどうかを示す値を返します。
オーバーロード
TryOpenExisting(String, Semaphore) |
既に存在する場合は、指定した名前付きセマフォを開き操作が成功したかどうかを示す値を返します。 |
TryOpenExisting(String, SemaphoreRights, Semaphore) |
既に存在する場合は、必要なセキュリティ アクセスを使って指定した名前付きセマフォを開き、操作が成功したかどうかを示す値を返します。 |
TryOpenExisting(String, Semaphore)
- ソース:
- Semaphore.cs
- ソース:
- Semaphore.cs
- ソース:
- Semaphore.cs
既に存在する場合は、指定した名前付きセマフォを開き操作が成功したかどうかを示す値を返します。
public:
static bool TryOpenExisting(System::String ^ name, [Runtime::InteropServices::Out] System::Threading::Semaphore ^ % result);
public static bool TryOpenExisting (string name, out System.Threading.Semaphore result);
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static bool TryOpenExisting (string name, out System.Threading.Semaphore? result);
public static bool TryOpenExisting (string name, out System.Threading.Semaphore? result);
static member TryOpenExisting : string * Semaphore -> bool
[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member TryOpenExisting : string * Semaphore -> bool
Public Shared Function TryOpenExisting (name As String, ByRef result As Semaphore) As Boolean
パラメーター
- name
- String
他のプロセスと共有される同期オブジェクトの名前。 名前の大文字と小文字は区別されます。 円記号 (\) は予約されており、名前空間の指定にのみ使用できます。 名前空間の詳細については、「解説」セクションを参照してください。 オペレーティング システムによっては、名前にさらに制限がある場合があります。 たとえば、Unix ベースのオペレーティング システムでは、名前空間を除外した後の名前は有効なファイル名である必要があります。
- result
- Semaphore
このメソッドから制御が戻るときに、呼び出しに成功した場合は名前付きセマフォを表す Semaphore オブジェクトが格納されます。呼び出しに失敗した場合は null
が格納されます。 このパラメーターは初期化前として処理されます。
戻り値
名前付きのセマフォが正常に開かれた場合は true
。それ以外の場合は false
。 場合によっては、無効な名前に対して false
が返されることがあります。
- 属性
例外
name
が null
です。
name
が無効です。 これは、不明なプレフィックスや無効な文字など、オペレーティング システムによって配置される可能性のある制限など、さまざまな理由で発生する可能性があります。 名前と共通プレフィックス "Global\" と "Local\" では大文字と小文字が区別されることに注意してください。 無効な名前があると、メソッドにより、代わりに false
が返される可能性があります。
または
その他のエラーが発生しました。
HResult
プロパティにさらに情報が含まれている場合があります。
name
は長すぎます。 長さの制限は、オペレーティング システムまたは構成によって異なる場合があります。
名前付きセマフォは存在しますが、それを使用するために必要なセキュリティ アクセスがユーザーにありません。
注釈
名前空間を name
指定するには、 の前 Global\
に または Local\
を付けます。 名前空間を Global
指定すると、同期オブジェクトをシステム上の任意のプロセスと共有できます。 名前空間が Local
指定されている場合 (名前空間が指定されていない場合も既定値) は、同期オブジェクトを同じセッション内のプロセスと共有できます。 Windows では、セッションはログイン セッションであり、通常、サービスは別の非対話型セッションで実行されます。 Unix に似たオペレーティング システムでは、各シェルに独自のセッションがあります。 セッションとローカルの同期オブジェクトは、プロセス間の同期に適している場合があります。これらはすべて同じセッションで実行される親子関係を持ちます。 Windows での同期オブジェクト名の詳細については、「 オブジェクト名」を参照してください。
要求された型の同期オブジェクトが名前空間に存在する場合は、既存の同期オブジェクトが開かれます。 名前空間に同期オブジェクトが存在しない場合、または別の型の同期オブジェクトが名前空間に存在する場合は、 false
が返されます。
システム セマフォがまだ存在しない場合にシステム セマフォを作成するには、 パラメーターを Semaphore 持ついずれかのコンストラクターを name
使用します。
名前付きセマフォが存在するかどうか不明な場合は、メソッド オーバーロードの OpenExisting(String) 代わりにこのメソッド オーバーロードを使用します。これにより、セマフォが存在しない場合は例外がスローされます。
このメソッド オーバーロードは、メソッド オーバーロードを TryOpenExisting 呼び出し、ビットごとの OR 演算を SemaphoreRights.Synchronize 使用して結合された および SemaphoreRights.Modify 権限を指定することと同じです。 フラグを SemaphoreRights.Synchronize 指定すると、スレッドはセマフォに入り、フラグを SemaphoreRights.Modify 指定するとスレッドは メソッドを Release 呼び出すことができます。
適用対象
TryOpenExisting(String, SemaphoreRights, Semaphore)
既に存在する場合は、必要なセキュリティ アクセスを使って指定した名前付きセマフォを開き、操作が成功したかどうかを示す値を返します。
public:
static bool TryOpenExisting(System::String ^ name, System::Security::AccessControl::SemaphoreRights rights, [Runtime::InteropServices::Out] System::Threading::Semaphore ^ % result);
public static bool TryOpenExisting (string name, System.Security.AccessControl.SemaphoreRights rights, out System.Threading.Semaphore result);
static member TryOpenExisting : string * System.Security.AccessControl.SemaphoreRights * Semaphore -> bool
Public Shared Function TryOpenExisting (name As String, rights As SemaphoreRights, ByRef result As Semaphore) As Boolean
パラメーター
- name
- String
他のプロセスと共有される同期オブジェクトの名前。 名前の大文字と小文字は区別されます。 円記号 (\) は予約されており、名前空間の指定にのみ使用できます。 名前空間の詳細については、「解説」セクションを参照してください。 オペレーティング システムによっては、名前にさらに制限がある場合があります。 たとえば、Unix ベースのオペレーティング システムでは、名前空間を除外した後の名前は有効なファイル名である必要があります。
- rights
- SemaphoreRights
必要なセキュリティ アクセス権を表す列挙値のビットごとの組み合わせ。
- result
- Semaphore
このメソッドから制御が戻るときに、呼び出しに成功した場合は名前付きセマフォを表す Semaphore オブジェクトが格納されます。呼び出しに失敗した場合は null
が格納されます。 このパラメーターは初期化前として処理されます。
戻り値
名前付きのセマフォが正常に開かれた場合は true
。それ以外の場合は false
。 場合によっては、無効な名前に対して false
が返されることがあります。
例外
name
が null
です。
name
が無効です。 これは、不明なプレフィックスや無効な文字など、オペレーティング システムによって配置される可能性のある制限など、さまざまな理由で発生する可能性があります。 名前と共通プレフィックス "Global\" と "Local\" では大文字と小文字が区別されることに注意してください。 無効な名前があると、メソッドにより、代わりに false
が返される可能性があります。
または
その他のエラーが発生しました。
HResult
プロパティにさらに情報が含まれている場合があります。
name
は長すぎます。 長さの制限は、オペレーティング システムまたは構成によって異なる場合があります。
名前付きセマフォは存在しますが、それを使用するために必要なセキュリティ アクセスがユーザーにありません。
注釈
名前空間を name
指定するには、 の前 Global\
に または Local\
を付けます。 名前空間を Global
指定すると、同期オブジェクトをシステム上の任意のプロセスと共有できます。 名前空間が Local
指定されている場合 (名前空間が指定されていない場合も既定値) は、同期オブジェクトを同じセッション内のプロセスと共有できます。 Windows では、セッションはログイン セッションであり、通常、サービスは別の非対話型セッションで実行されます。 Unix に似たオペレーティング システムでは、各シェルに独自のセッションがあります。 セッションとローカルの同期オブジェクトは、プロセス間の同期に適している場合があります。これらはすべて同じセッションで実行される親子関係を持ちます。 Windows での同期オブジェクト名の詳細については、「 オブジェクト名」を参照してください。
要求された型の同期オブジェクトが名前空間に存在する場合は、既存の同期オブジェクトが開かれます。 名前空間に同期オブジェクトが存在しない場合、または別の型の同期オブジェクトが名前空間に存在する場合は、 false
が返されます。
システム セマフォがまだ存在しない場合にシステム セマフォを作成するには、 パラメーターを Semaphore 持ついずれかのコンストラクターを name
使用します。
名前付きセマフォが存在するかどうか不明な場合は、メソッド オーバーロードの OpenExisting(String, SemaphoreRights) 代わりにこのメソッド オーバーロードを使用します。これにより、セマフォが存在しない場合は例外がスローされます。
パラメーターには rights
、スレッドが SemaphoreRights.Synchronize セマフォを入力できるようにするための フラグと、スレッドが メソッドを SemaphoreRights.Modify 呼び出せるようにするための フラグを Release 含める必要があります。
に同じ値 name
を使用するこのメソッドを複数回呼び出しても、返されるオブジェクトが同じ Semaphore 名前付きシステム セマフォを表していても、必ずしも同じオブジェクトを返すわけではありません。
適用対象
.NET