AddRange()
instance.AddRange(tList*)
Adds a range of MfObject instances to MfParams.
tList
Various objects to add to MfParams. See MfParams section below.
Throws MfNullReferenceException if MfParams is not set to an instance.
Throws MfException if unable to add tList item to MfParams with an inner Exception.
MfParams can contain several different types. Such as but not limited to, MfString, MfInteger, MfFloat , MfChar and any object derived from MfObject.
If AllowOnlyAhkObj is set to true (default) then any Object derived from MfObject or any var is valid as a parameter; Otherwise any object or var can be added.
Vars can be added but are Always converted to MfString if they do not contain Key Value Pairs and then added to MfParams. AddRange method and Constructor accept the same types of parameters.
AddRange and Constructor can accept mixed paramaters.
intA := new MfInteger(10) ; Create a new MfInteger object
intB = new MfInteger(13) ; Create a new MfInteger object
; create a new instance of MfParams and add MfInteger, MfInteger, MfChar, MfString
p := new MfParams(intA,intB,"c=%","s=Hello World")
is the same as
p := new MfParams() ; create a new instance of MfParams
; add MfInteger, MfInteger, MfChar, MfString
p.AddRange(intA,intB,"c=%","s=Hello World")
Key Value MfParams are accepted for convenience.
Key Value pairs are constructed as string vars.
Valid Keys are
Keys are case insensitive (i is the same as I)
Key Values can be seperated by = or : or | ("i=10", "i:10" and "i|10" are interpreted as the same)
Key Values can be combined into one String.
p := new MfParams() ; create a new instance of MfParams
p.AddRange("i=10","s=Hello World", "f=12.44")
is the same as
p := new MfParams() ; create a new instance of MfParams
p.AddRange("i=10, s=Hello World, f=12.44")
is the same as
p := new MfParams("i=10, s=Hello World, f=12.44") ; create a new instance of MfParams and add parameters
Commas can be escaped using \ in strings
p := new MfParams()
P.AddRange("i=10,i=12,s=one\, two\, three") ; Adds MfInteger of 10, MfInteger of 12 and MfString of "one, two, three"
AddRange method and Constructor accept the same types of parameters.
p := new MfParams("i:10,c:$,S:Hello world") ; create a new instance add MfInteger, MfChar, MfString
is the same as
p := new MfParams() ; create a new instance
p.AddRange("i:10,c:$,S:Hello world") ; add MfInteger, MfChar, MfString
; Example AddRange using MfParams static Primitive generators
p := new MfParams() ; create a new instance of MfParams
p.AddRange(MfParams.I(10), MfParams.S("Hello World"), MfParams.C("%"))
MsgBox % p.ToString() ; Displays MfInteger,MfString,MfChar
result := MyFunc(p)
MsgBox %result%
/* result contains
* Integer:10
* String:Hello World
* Char:%
*/
p := new MfParams() ; create a new instance of MfParams
p.AddRange("I=10", "S=Hello World", "C=%")
MsgBox % p.ToString() ; Displays MfInteger,MfString,MfChar
result := MyFunc(p)
MsgBox %result%
/* result contains
* Integer:10
* String:Hello World
* Char:%
*/
p := new MfParams() ; create a new instance of MfParams
str := "Hello World"
p.AddRange("I=10", "S=%str%", "C=%")
MsgBox % p.ToString() ; Displays MfInteger,MfString,MfChar
result := MyFunc(p)
MsgBox %result%
/* result contains
* Integer:10
* String:%str%
* Char:%
*/
p := new MfParams() ; create a new instance of MfParams
str := "Hello World"
p.AddRange("I=10", "S=" . str, "C=%")
MsgBox % p.ToString() ; Displays MfInteger,MfString,MfChar
result := MyFunc(p)
MsgBox %result%
/* result contains
* Integer:10
* String:Hello World
* Char:%
*/
p := new MfParams() ; create a new instance of MfParams
str := "Hello World"
; adding a string var will be converted to MfString instance
p.AddRange("I=10", str, "C=%")
MsgBox % p.ToString() ; Displays MfInteger,MfString,MfChar
result := MyFunc(p)
MsgBox %result%
/* result contains
* Integer:10
* String:Hello World
* Char:%
*/
p := new MfParams() ; create a new instance of MfParams
str := "Hello World"
; parameter can be mixed and matched
p.AddRange("I=10", str, new MfChar("%"))
MsgBox % p.ToString() ; Displays MfInteger,MfString,MfChar
result := MyFunc(p)
MsgBox %result%
/* result contains
* Integer:10
* String:Hello World
* Char:%
*/
p := new MfParams() ; create a new instance of MfParams
; valid separators between type and value are (= : |)
p.AddRange("I=10", "S:Hello World", "C|=")
MsgBox % p.ToString() ; Displays MfInteger,MfString,MfChar
result := MyFunc(p)
MsgBox %result%
/* result contains
* Integer:10
* String:Hello World
* Char:=
*/
p := new MfParams()
; Multiple parameters can be added in one string separated by comma
; to escape commas use the backspace character (\)
; notice how the commas after one and two are escaped
p.AddRange("i=10,s=one\, two\, three,c|=")
MsgBox % p.ToString() ; Displays MfInteger,MfString,MfChar
result := MyFunc(p)
MsgBox %result%
/* result contains
* Integer:10
* String:one, two, three
* Char:=
*/
ExitApp
; Example function
MyFunc(args*) {
; check to see if the first arg is in instance of MfPrams and use if it is
; args is 1 base index
if (MfObject.IsObjInstance(args[1], MfParams))
{
p := args[1] ; arg 1 is a MfParams object so we will use it
} else {
; Mfparams was not passed in so we will create an instance and add all the args
p := new MfParams()
for index, arg in args
{
p.Add(arg)
}
}
; this method only takes 1 to 3 arguments so we will check and throw an error if wrong number of args
if ((p.Count < 1) || (p.Count > 3)) {
e := new MfNotSupportedException(MfEnvironment.Instance.GetResourceString("NotSupportedException_MethodOverload"))
e.SetProp(A_LineFile, A_LineFile, A_ThisFunc)
throw e
}
strParams := p.ToString()
retval := "unknown"
if (strParams = "MfString") {
str := p.GetValue(0) ; get the first item in the params
retval := str
} else if (strParams = "MfString,MfInteger") {
str := p.GetValue(0) ; get the first item in the params
int := p.GetValue(1) ; get the second item in the params
retval := "String:" . str . " Integer:" . int
} else if (strParams = "MfString,MfString") {
strObjA := p.Item[0] ; get the first object which is a String Object
strObjA := p.Item[1] ; get the second object which is a String Object
retval := MfString.Format("StringA:{0}`nStringB:{1}", strObjA.Value, strObjB.Value)
} else if (strParams = "MfString,MfChar") {
str := p.GetValue(0) ; get the first item in the params
strCh := p.GetValue(1) ; get the second item in the params
retval := MfString.Format("String:{0}`nChar:{1}", str, strCh)
} else if (strParams = "MfInteger,MfString,MfChar") {
retval := MfString.Format("Integer:{0}`nString:{1}`nChar:{2}", p.Item[0].Value, p.Item[1].Value, p.Item[2].Value)
}
; optionally return different value using Data Property
if (p.Data.Contains("ReturnAsObject") && (p.Data.Item["ReturnAsObject"] = true)) {
return new MfString(retval) ; return a new instance of MfString
} else {
return retval
}
}