GetValue()
Overrides MfPrimitive.GetValue().
OutputVar := MfSByte.GetValue(Obj)
OutputVar := MfSByte.GetValue(Obj, Default)
OutputVar := MfSByte.GetValue(Obj, Default, AllowAny)
Gets the byte number from Object or var containing byte.
Obj
The Object or var containing, byte or hex value
Can be any type that matches IsNumber.
Returns a var containing a byte No less then MinValue and no greater then MaxValue.
Static Method
Throws an error if unable to convert Obj to byte.
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 byte value.
Gets a byte number from Obj or returns Default value if Obj is unable to be converted to byte. Default must be a value that can be converted to byte or it will be ignored if Obj can not be converted to byte and an error will be thrown.
Obj
The Object or var containing, integer or hex value
Can be any type that matches IsIntegerNumber.
Default
The value to return if Obj is Cannot be converted
Can be any type that matches IsIntegerNumber or var of byte.
Returns a var containing a byte or Default value if Obj is unable to be converted to byte.
Static Method
If Default is not a valid byte or MfSByte instance then GetValue will throw an error if Obj can not be converted to byte.
If Default can not be converted to a byte then this would method will yield the same results as calling MfByte.GetValue(Obj).
Throws MfInvalidOperationException if not called as a static method.
Gets a byte var from Obj or returns Default value if Obj is unable to be converted to byte.Default can be not boolean if AllowAny is true.
Obj
The Object or var containing, integer or hex value
Can be any type that matches IsIntegerNumber.
Default
The value to return if Obj is Cannot be converted
Can be any type that matches IsIntegerNumber or var of byte.
AlowAny
Determines if Default can be a value other then byte. If true Default can be any var, Object or null; Otherwise Default must be a byte 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 MfByte.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. For instance MfInteger.GetValue(2.8) will be 2.
Throws MfNotSupportedException if incorrect number of parameters are passed in.
Obj := new MfInt64(233)
val := MfSByte.GetValue(Obj)
MsgBox %val% ; Throws MfArgumentException, MaxValue is 127
Obj := new MfByte(14)
val := MfSByte.GetValue(Obj)
MsgBox %val% ; displays 14
val := MfSByte.GetValue(214)
MsgBox %val% ; displays 214
; the following will throw MfArgumentException
; MfSByte can be min of -128 and max of 127
val := MfSByte.GetValue(0xE5F4) ; 0xE5F4 = 58868
MsgBox %val%
; the following will display zero due to byte overflow Default is returned
; MfSByte can be min of -128 and max of 127
val := MfSByte.GetValue(0xE5F4, 0) ; 0xE5F4 = 58868
MsgBox %val% ; displays 0
; the following will throw MfArgumentException
; MfSByte can be min of -128 and max of 127
; Default value passed in is not a valid byte
val := MfSByte.GetValue(0xE5F4, -200) ; 0xE5F4 = 58868
MsgBox %val%
; the following will display -1 due to byte overflow Default is returned
; MfSByte can be min of -128 and max of 127
; Default value passed in is not a valid byte but will return anyways
; because AllowAny is Set to true
val := MfSByte.GetValue(58868, -200, true)
MsgBox %val% ; displays -200
val := MfSByte.GetValue(0x01A)
MsgBox %val% ; displays 36
; the following will throw MfArgumentException
val := MfSByte.GetValue("abc")
MsgBox %val%
; the Default set to 25 will be returned
val := MfSByte.GetValue("abc", 25)
MsgBox %val% ; displays 25
VarDefault := new MfSByte(MfSByte.MaxValue)
val := MfSByte.GetValue("abc", VarDefault)
MsgBox %val% ; displays 127
; Default Obj is not a valid byte and Default
; is not a valid byte but AllowAny is true
val := MfSByte.GetValue("abc", "Undefined", true)
MsgBox %val% ; displays Undefined
; MfNumberStyles.Instance.Number is MfEnum.EnumItem
; and MfEnum.EnumItem is of type IsIntegerNumber
val := MfSByte.GetValue(MfNumberStyles.Instance.Number)
MsgBox %val% ; displays 111