Extensions.DiagCom.GetParameterAsList
Jump to navigation
Jump to search
Contents
Classification
| Name | GetParameterAsList |
| Short Description | Gets the list of parameters within a parameter |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | Parameter related terms |
| Exceptions | TypeMismatchException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ListTerm DiagCom.GetParameterAsList(ParameterContainerTerm parameterContainer);
Description
The GetParameterAsList term accepts a ParameterContainerTerm and returns an otx:List of Parameter handles, corresponding to the contents of the passed in parameter container object. This term is used in case a parameter of a diagnostic service contains a set of parameters. If the parameter supports child parameters, all child parameters will be returned. This list can be empty. If the parameter does not support child parameters, a TypeMismatchException will be thrown.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| List | List of parameter (Type Parameter) |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ParameterContainer | ParameterContainer | Term | - | [1] | The ParameterContainer whose value will be returned as an otx:List. |
OTL Examples
/// Local Declarations
DiagCom.Request Request1;
List<DiagCom.Parameter> List1;
DiagCom.ComChannel ComChannel1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_RoutiContrCheckMemor"));
List1 = DiagCom.GetParameterAsList(Request1);
See also
GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest
ExecuteDiagService
GetFirstResponse
GetAllResponses
GetParameterBySemantic
GetParameterByPath
