Fact function

Warning

This documentation refers to the Classic QDK, which has been replaced by the Modern QDK.

Please see https://aka.ms/qdk.api for the API documentation for the Modern QDK.

Checks whether a classical condition is true, and throws an exception if it is not.

function Fact (actual : Bool, message : String) : Unit

Input

The condition to be checked.

Failure message string to be used as an error message if the classical condition is false.

The following Q# snippet will throw an exception:

Fact(false, "Expected true.");