Parameter.ToString Method

Article
12/13/2013

Applies To: Windows 8.1

Retrieve the value of the parameter as a specific data type.

Namespace: Microsoft.Assessments.Runtime
Assembly: Microsoft.Assessments.Core (in Microsoft.Assessments.Core.dll)

Usage

'Usage
Dim instance As Parameter
Dim returnValue As String

returnValue = instance.ToString

Syntax

'Declaration
Public Overrides Function ToString As String

public override string ToString ()

public:
virtual String^ ToString () override

public String ToString ()

public override function ToString () : String

Return Value

Returns String.

Remarks

This method returns a type safe value of a parameter. The method checks 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, the method returns an error that the conversion failed.

If this returns 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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows 8.1