Extensions.DiagCom.GetComParameterValueAsInteger

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

Classification

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

Pseudo-Code Syntax

Integer GetComParameterValueAsInteger(ComChannel comChannel, String comParameterName);

Description

The GetComParameterValueAsInteger term return the current value of a Integer 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
Integer The current value of a Integer 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

Integer result = GetComParameterValueAsInteger(comChannel, "parameterName");

See also

GetComParameterValueAsBoolean
GetComParameterValueAsString
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity