Difference between revisions of "Extensions.DiagCom.GetParameterValueAsString"
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetParameterValueAsString''' term accepts a [[ParameterTerm]] and returns the actual value of the parameter as a [[String]] | + | The '''GetParameterValueAsString''' term accepts a [[ParameterTerm]] and returns the actual value of the parameter as a [[String]]. |
{{TermReturnValue| [[String]] | The actual value of the parameter as a [[String]].)}} | {{TermReturnValue| [[String]] | The actual value of the parameter as a [[String]].)}} | ||
Revision as of 10:02, 17 July 2014
Contents
Classification
| Name | GetParameterValueAsString |
| Short Description | The actual value of the parameter as a String |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | Parameter related terms |
| Exceptions | TypeMismatchException |
| Checker Rules | - |
| Standard Compliant | Yes |
Pseudo-Code Syntax
GetParameterValueAsString(Parameter parameter, String value);Description
The GetParameterValueAsString term accepts a ParameterTerm and returns the actual value of the parameter as a String.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| String | The actual value of the parameter as a String.) |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Parameter | Parameter | Term | - | [1] | The parameter object. |
Examples
String value = GetParameterValueAsString(parameter);See also
GetParameterValueAsBoolean
GetParameterValueAsInteger
GetParameterValueAsFloat
GetParameterValueAsByteField
GetParameterValueAsQuantity
