Extensions.DiagCom.GetComParameterValueAsString

From emotive
Revision as of 07:23, 18 July 2014 by Nb (talk | contribs) (Created page with "Category:DiagCom == Classification == {{ClassificationActivity | GetComParameterValueAsString | The current value of a String communication parameter | Term | Di...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Classification

Name GetComParameterValueAsString
Short Description The current value of a String communication parameter
Class Term
Extension OTX DiagCom extension
Group ComParam related terms
Exceptions UnknownTargetException
TypeMismatchException
Checker Rules -
Standard Compliant Yes

Pseudo-Code Syntax

String GetComParameterValueAsString(ComChannel comChannel, String comParameterName);

Description

The GetComParameterValueAsString term return the current value of a String communication parameter.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
String The current value of a String communication parameter.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] Communication channel.
ComParameterName String Term - [1] Name of communication channel.

Examples

String result = GetComParameterValueAsString(comChannel, "parameterName");

See also

GetComParameterValueAsBoolean
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity