GetValue()
Overrides MfPrimitive.GetValue().
OutputVar := MfUInt16.GetValue(Obj)
OutputVar := MfUInt16.GetValue(Obj, Default)
OutputVar := MfUInt16.GetValue(Obj, Default, AllowAny)
Gets the integer number from Object or var containing integer.
Obj
The Object or var containing, integer or hex value
Can be any type that matches IsNumber.
Returns a var containing a integer No less then MinValue and no greater then MaxValue.
Static Method
Throws an error if unable to convert Obj to integer.
Throws MfInvalidOperationException if not called as a static method.
Throws MfArgumentOutOfRangeException if Obj is less then MinValue or Greater then MaxValue.
Throws MfArgumentException if argument Obj is can not be converted to integer value.
Gets a integer number from Obj or returns Default value if Obj is unable to be converted to integer. Default must be a value that can be converted to integer or it will be ignored if Obj can not be converted to integer an error will be thrown.
Obj
The Object or var containing, integer or hex value
Can be any type that matches IsNumber.
Default
The value to return if Obj is Cannot be converted
Can be any type that matches IsNumber or var of integer.
Returns a var containing a integer or Default value if Obj is unable to be converted to integer.
Static Method
If Default is not a valid integer or MfUInt16 instance then GetValue will throw an error if Obj can not be converted to integer.
If Default can not be converted to a integer then this would method will yield the same results as calling MfUInt16.GetValue(Obj).
Throws MfInvalidOperationException if not called as a static method.
Gets a integer number from Obj or returns Default value if Obj is unable to be converted to integer.
Obj
The Object or var containing, integer or hex value
Can be any type that matches IsNumber.
Default
The value to return if Obj is Cannot be converted
Can be any type that matches IsNumber or var of integer.
AlowAny
Determines if Default can be a value other then integer. If true Default can be any var, Object or null; Otherwise Default must be a integer value.
Static Method.
If AllowAny is true then Default can be any value including var, object or null. However if AllowAny is false then this method will yield the same result as calling MfUInt16.GetValue(Obj, Default).
Throws MfInvalidOperationException if not called as a static method.
Throws MfArgumentException if AllowAny is not a valid boolean.
If Obj is a float or MfFloat instance then GetValue() will alway round down for positive number and round up for negative numbers. For instance MfInt16.GetValue(2.8) will be 2 and MfInt16.GetValue(-2.8) will be -2.
Throws MfNotSupportedException if incorrect number of parameters are passed in.
Obj := new MfUInt16(233)
val := MfUInt16.GetValue(Obj)
MsgBox %val% ; displays 233
Obj := new MfUInt16(214)
val := MfUInt16.GetValue(Obj)
MsgBox %val% ; displays 214
val := MfUInt16.GetValue(214)
MsgBox %val% ; displays 214
; the following will throw MfArgumentOutOfRangeException
; MfInt16 can be min of 0 and max of 65535
val := MfUInt16.GetValue(65536.201)
MsgBox %val%
; the following will display zero due to uint16 overflow Default is returned
; MfUInt16 can be min of 0 and max of 65535
val := MfInt64.GetValue(65536.201, 0)
MsgBox %val% ; displays 0
flt := new MfFloat(32727.8)
val := MfUInt16.GetValue(flt)
MsgBox %val% ; displays 32727
val := MfUInt16.GetValue(0x00F4)
MsgBox %val% ; displays 244
; the following will throw MfArgumentException
val := MfInt16.GetValue("abc")
MsgBox %val%
; the Default set to 25 will be returned
val := MfUInt16.GetValue("abc", 25)
MsgBox %val% ; displays 25
VarDefault := new MfUInt16(MfUInt16.MaxValue)
val := MfUInt16.GetValue("abc", VarDefault)
MsgBox %val% ; displays 65535
; Default Obj is not a valid integer and Default
; is not a valid integer but AllowAny is true
val := MfUInt16.GetValue("abc", "Undefined", true)
MsgBox %val% ; displays Undefined
; MfNumberStyles.Instance.Number is MfEnum.EnumItem
; and MfEnum.EnumItem is of type IsIntegerNumber
val := MfUInt16.GetValue(MfNumberStyles.Instance.Number)
MsgBox %val% ; displays 111