Contract.Requires メソッド

定義

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定します。Specifies a precondition contract for an enclosing method or property.

オーバーロード

Requires(Boolean)

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定します。Specifies a precondition contract for the enclosing method or property.

Requires(Boolean, String)

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定し、コントラクトの条件が失敗した場合はメッセージを表示します。Specifies a precondition contract for the enclosing method or property, and displays a message if the condition for the contract fails.

Requires<TException>(Boolean)

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定し、コントラクトの条件が失敗した場合は例外をスローします。Specifies a precondition contract for the enclosing method or property, and throws an exception if the condition for the contract fails.

Requires<TException>(Boolean, String)

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定し、コントラクトの条件が失敗した場合は指定されたメッセージで例外をスローします。Specifies a precondition contract for the enclosing method or property, and throws an exception with the provided message if the condition for the contract fails.

Requires(Boolean)

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定します。Specifies a precondition contract for the enclosing method or property.

public:
 static void Requires(bool condition);
[System.Diagnostics.Conditional("CONTRACTS_FULL")]
public static void Requires (bool condition);
static member Requires : bool -> unit
Public Shared Sub Requires (condition As Boolean)

パラメーター

condition
Boolean

テストする条件式。The conditional expression to test.

属性

注釈

  • このメソッドの呼び出しは、他のコードの前にあるメソッドまたはプロパティの先頭にある必要があります。This method call must be at the beginning of a method or property, before any other code.

  • このコントラクトはクライアントに公開されます。したがって、少なくとも外側のメソッドとして表示されるメンバーのみを参照する必要があります。This contract is exposed to clients; therefore, it must only reference members that are at least as visible as the enclosing method.

  • 旧バージョンとの互換性で特定の例外をスローする必要がない場合は、Contract.Requires<TException>(Boolean) メソッドの代わりにこのメソッドを使用します。Use this method instead of the Contract.Requires<TException>(Boolean) method when backward compatibility does not force you to throw a particular exception.

Requires(Boolean, String)

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定し、コントラクトの条件が失敗した場合はメッセージを表示します。Specifies a precondition contract for the enclosing method or property, and displays a message if the condition for the contract fails.

public:
 static void Requires(bool condition, System::String ^ userMessage);
[System.Diagnostics.Conditional("CONTRACTS_FULL")]
public static void Requires (bool condition, string userMessage);
static member Requires : bool * string -> unit
Public Shared Sub Requires (condition As Boolean, userMessage As String)

パラメーター

condition
Boolean

テストする条件式。The conditional expression to test.

userMessage
String

条件が false の場合に表示するメッセージ。The message to display if the condition is false.

属性

注釈

  • このメソッドの呼び出しは、他のコードの前にあるメソッドまたはプロパティの先頭にある必要があります。This method call must be at the beginning of a method or property, before any other code.

  • このコントラクトはクライアントに公開されます。したがって、少なくとも外側のメソッドとして表示されるメンバーのみを参照する必要があります。This contract is exposed to clients; therefore, it must only reference members that are at least as visible as the enclosing method.

  • 旧バージョンとの互換性で特定の例外をスローする必要がない場合は、Contract.Requires<TException>(Boolean, String) メソッドの代わりにこのメソッドを使用します。Use this method instead of the Contract.Requires<TException>(Boolean, String) method when backward compatibility does not force you to throw a particular exception.

Requires<TException>(Boolean)

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定し、コントラクトの条件が失敗した場合は例外をスローします。Specifies a precondition contract for the enclosing method or property, and throws an exception if the condition for the contract fails.

public:
generic <typename TException>
 where TException : Exception static void Requires(bool condition);
public static void Requires<TException> (bool condition) where TException : Exception;
static member Requires : bool -> unit (requires 'Exception :> Exception)
Public Shared Sub Requires(Of TException As Exception) (condition As Boolean)

型パラメーター

TException

条件が false の場合にスローする例外。The exception to throw if the condition is false.

パラメーター

condition
Boolean

テストする条件式。The conditional expression to test.

注釈

重要

Requires メソッドを使用するには、実行時チェックをオンにする必要があります。You must turn on run-time checking to use the Requires method. ランタイムチェックがオフになっている場合、プロセスは終了します。If run-time checking is turned off, the process will be terminated. ランタイムチェック用のツールを入手するには、MSDN DevLabs Web サイトのコードコントラクトに関するページを参照してください。To obtain the tools for runtime checking, see Code Contracts on the MSDN DevLabs Web site.

  • このメソッドの呼び出しは、他のコードの前にあるメソッドまたはプロパティの先頭にある必要があります。This method call must be at the beginning of a method or property, before any other code.

  • このコントラクトはクライアントに公開されます。したがって、少なくとも外側のメソッドとして表示されるメンバーのみを参照する必要があります。This contract is exposed to clients; therefore, it must only reference members that are at least as visible as the enclosing method.

  • 事前条件が失敗した場合に例外をスローする場合は、Contract.Requires(Boolean) メソッドの代わりにこのメソッドを使用します。Use this method instead of the Contract.Requires(Boolean) method when you want to throw an exception if the precondition fails.

Requires<TException>(Boolean, String)

外側のメソッドまたはプロパティの実行前の状態のコントラクトを指定し、コントラクトの条件が失敗した場合は指定されたメッセージで例外をスローします。Specifies a precondition contract for the enclosing method or property, and throws an exception with the provided message if the condition for the contract fails.

public:
generic <typename TException>
 where TException : Exception static void Requires(bool condition, System::String ^ userMessage);
public static void Requires<TException> (bool condition, string userMessage) where TException : Exception;
static member Requires : bool * string -> unit (requires 'Exception :> Exception)
Public Shared Sub Requires(Of TException As Exception) (condition As Boolean, userMessage As String)

型パラメーター

TException

条件が false の場合にスローする例外。The exception to throw if the condition is false.

パラメーター

condition
Boolean

テストする条件式。The conditional expression to test.

userMessage
String

条件が false の場合に表示するメッセージ。The message to display if the condition is false.

注釈

  • 重要

    Requires メソッドを使用するには、実行時チェックをオンにする必要があります。You must turn on run-time checking to use the Requires method. ランタイムチェックがオフになっている場合、プロセスは終了します。If run-time checking is turned off, the process will be terminated. ランタイムチェック用のツールを入手するには、MSDN DevLabs Web サイトのコードコントラクトに関するページを参照してください。To obtain the tools for runtime checking, see Code Contracts on the MSDN DevLabs Web site.

    このメソッドの呼び出しは、他のコードの前にあるメソッドまたはプロパティの先頭にある必要があります。This method call must be at the beginning of a method or property, before any other code.

  • このコントラクトはクライアントに公開されます。したがって、少なくとも外側のメソッドとして表示されるメンバーのみを参照する必要があります。This contract is exposed to clients; therefore, it must only reference members that are at least as visible as the enclosing method.

  • 事前条件が失敗した場合に例外をスローする場合は、Contract.Requires(Boolean, String) メソッドの代わりにこのメソッドを使用します。Use this method instead of the Contract.Requires(Boolean, String) method when you want to throw an exception if the precondition fails.

適用対象