Parse()

OutputVar := MfBool.Parse(obj)

MfBool.Parse(obj)

Converts the specified string representation of a logical value to its Boolean equivalent, or throws an exception if the string is not equal to the value of TrueString or FalseString.

Parameters

obj

An instance of MfString or var containing a boolean representation to convert.
Can also be instance of MfParams.

Returns

Returns var containing integer equivalent to the number contained in obj or throws an error if unable to parse obj param.

Variadic Method; This method is Variadic so you may construct an instance of MfParams containing any of the overload method parameters listed above and pass in the MfParams instance to the method instead of using the overloads described above. See MfParams for more information.

Remarks

Converts the obj specified string representation of a boolean to its MfBool equivalent.
If obj parameter is an *Objects then it must be instance from MfObject or be an instance of MfParams.
If MfParams is passed in with Data added ReturnAsObject set to true then parsed result will be returned as an instance of MfInteger; Otherwise a var integer will be returned. See example below.

Throws

Throws MfInvalidOperationException if not called as a static method.
Throws MfFormatException if unable to parse obj.
Throws MfArgumentNullException if no parameters are passe in.
Throws MfNotSupportedException if incorrect number of parameters are passed in.

Example

; Input of true parses to 1
; input of True parses to 1
; input of false parses to 0
; input of abc resuts in an error
; leading and trailing spaces are allowed
try {
    InputBox, myInput, Enter value, Enter a true or false to parse!
    if (MfNull.IsNull(myInput))
    {
        MsgBox Sorry no input!
    } else {
        bool := MfBool.Parse(myInput)
        MsgBox My boolean is:%bool%
    }
} catch e {
    MsgBox, 8240, Error, % "An error has occured!`r`n" . e.Message
}
ExitApp

; Example using MfParams and adding ReturnAsObject to MfParams.Data
; this example passes MfParams into MfBool.Parse method with
; Data Key of ReturnAsObject. This cause MfBool.Parse to return is value
; as an instance of MfBool rather then the default of a var containing boolean.
pStr := "true"
Parms := new MfParams()
Parms.AddString(pStr)
Parms.Data.Add("ReturnAsObject",true)
boolObj := MfBool.Parse(Parms)
MsgBox % boolObj.Value