Error
Summary
Emits a custom error and halts BFF parsing.
Error( "String or $VarName$" )
Details
The Error() function allows BFF parsing to be terminated and a custom error message to be emitted. BFF parsing will have been considered to have failed and building will not be possible.
Examples
The following sample BFF:
.RequiredFASTBuildVersion = 97
If( ._FASTBUILD_VERSION_ < .RequiredFASTBuildVersion )
{
Error( 'FASTBuild v0.97 or later is required (found $_FASTBUILD_VERSION_STRING_$)' );
}
Will generate the following output if the version is as expected:
C:\Test\fbuild.bff(5,5): FASTBuild Error #1999 - Error() - User Error: FASTBuild v0.97 or later is required (found v0.96)
Error( 'FASTBuild v0.97 or later is required (found $_FASTBUILD_VERSION_STRING_$)' );
^
\--here