This documentation is archived and is not being maintained.

Convert::ToBoolean Method (String, IFormatProvider)

Converts the specified string representation of a logical value to its Boolean equivalent, using the specified culture-specific formatting information.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public:
static bool ToBoolean(
	String^ value, 
	IFormatProvider^ provider
)

Parameters

value
Type: System::String
A string that contains the value of either Boolean::TrueString or Boolean::FalseString.
provider
Type: System::IFormatProvider
An object that supplies culture-specific formatting information. This parameter is ignored.

Return Value

Type: System::Boolean
true if value equals Boolean::TrueString, or false if value equals Boolean::FalseString or nullptr.

ExceptionCondition
FormatException

value is not equal to TrueString or FalseString.

If you prefer not to handle an exception if the conversion fails, you can call the Boolean::TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: