SysUtils.TryStrToBool Function

Converts a string to a Boolean value, with a Boolean success code.

Pascal

function TryStrToBool(const S: string; out Value: Boolean): Boolean; overload;

C++

Boolean TryStrToBool(const AnsiString S, Boolean Value);

File

SysUtils

Description

TryStrToBool converts the string specified by S to a Boolean and sets Value to the result. If S can be converted to a number, TryStrToBool sets Value to false if that number is 0, true otherwise. If S can't be converted to a number, TryStrToBool returns true if S is any of the strings listed in TrueBoolStrs (or differs from one only by case) and false if it is any of the strings listed in FalseBoolStrs (or differs from one only by case). If S is not a number and not one of the strings listed in TrueBoolStrs or FalseBoolStrs, TryStrToBool returns false to indicate that the conversion failed. If the conversion is successful, TryStrToBool returns true.

Note: If you do not assign a value to TrueBoolStrs, it is treated as if it contains the single string 'True'. Similarly, if you do not assign a value to FalseBoolStrs, it is treated as if it contains the single string 'False';

Note: The TrueBoolStrs and FalseBoolStrs variables are undefined when an application starts. Any use of StrToBool, BoolToStr or TryStrToBool will cause these variables to be initialised with the default values above.