GetValue()
Overrides MfPrimitive.GetValue()
OutputVar := MfString.GetValue(str)
Gets the string value as var from MfString object or var containing a String
obj
The MfString object or var containing a string or object deriving from MfObject.
Returns a var containing a string or MfString.Empty if str is null or empty.
This method is not affected by the ReturnAsObject and always returns a var.
Throws MfNotSupportedException if argument obj is Object but is not derived from MfObject.
If obj is not a MfString instance but is derived from MfObject then the ToString() value is returned from the object. GetValue can be useful when your not sure if a string var or an instance of MfString or other object derived from MfObject is passed as a parameter.
Example
try
{
DisplayMyText("Hello World") ; Displays Hello World Message
mfs := new MfString("The sky is blue today") ; Displays The sky is blue today Message
DisplayMyText(mfs)
}
catch e
{
msg := e.Message
MsgBox, 0, Error, An Error has occurred`n%msg%
}
DisplayMyText(strText)
{
; throw an error if param is empty
if (MfString.IsNullOrEmpty(strText))
{
ex := new MfArgumentNullException("strText")
ex.SetProp(A_LineFile, A_LineNumber, A_ThisFunc)
throw ex
}
; get text as var in case strText was passed as instance of MfString
_str := MfString.GetValue(strText)
; _str will be a string var if it was passed in a a var or as an MfString
MsgBox, 64, My Display Text, %_str%
}