Parameter class
This interface exposes assessment parameter values to the assessment.
When to implement
Never. This interface is implemented by Axe and provided to the assessment.
Parameter has these types of members:
Methods
The Parameter class has these methods.
| Method | Description |
|---|---|
| ~Parameter | Destructor method. |
| ToBoolean | Retrieve the value of the parameter as a specific data type. |
| ToByte | Retrieve the value of the parameter as a specific data type. |
| ToChar | Retrieve the value of the parameter as a specific data type. |
| ToDateTime | Retrieve the value of the parameter as a specific data type. |
| ToDouble | Retrieve the value of the parameter as a specific data type. |
| ToDuration | Retrieve the value of the parameter as a specific data type. |
| ToInt16 | Retrieve the value of the parameter as a specific data type. |
| ToInt32 | Retrieve the value of the parameter as a specific data type. |
| ToInt64 | Retrieve the value of the parameter as a specific data type. |
| ToSByte | Retrieve the value of the parameter as a specific data type. |
| ToString | Retrieve the value of the parameter as a specific data type. |
| ToUInt16 | Retrieve the value of the parameter as a specific data type. |
| ToUInt32 | Retrieve the value of the parameter as a specific data type. |
| ToUInt64 | Retrieve the value of the parameter as a specific data type. |
Remarks
These methods are used to return a type safe value of a parameter. These methods check the underlying data type of the parameter and if the type is not the same as the one requested, or if there is not a mapping then a conversion failed error is returned.
If these return any error, all the bits of the output value are set to zero or to the empty string, and the value of paramValue is set to false. A non-zero value has a Boolean value of true and a value of zero has a Boolean value of false.
The ToString, ToDouble and ToDateTime methods cannot convert a parameter of another type. If these methods are called on a parameter of a different type, the method returns AXE_E_PARAM_CONVERSION_FAILED.
This interface is supported on Windows 7, Windows Server 2008 R2, Windows 8, and Windows Server 2012.
Requirements
| Minimum supported client |
Windows 7 [desktop apps only] |
| Minimum supported server |
Windows Server 2008 R2 [desktop apps only] |
| Header |
|
| DLL |
|