Difference between revisions of "Extensions.DiagDataBrowsing.GetRequestParameterList"
Jump to navigation
Jump to search
| (2 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | ListTerm DiagDataBrowsing.GetRequestParameterList(DiagServiceTerm DiagService); | |
| − | |||
| − | |||
| − | |||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 14: | Line 11: | ||
'''GetRequestParameterList''' returns a list of strings containing the names of all request parameters of a given diagnostic service. | '''GetRequestParameterList''' returns a list of strings containing the names of all request parameters of a given diagnostic service. | ||
| − | {{Note|NOTE — In the case of a MVCI/ODX based system, the returned list | + | {{Note|NOTE — In the case of a MVCI/ODX based system, the returned list will contain the SHORT-NAMEs of all PARAM objects (enclosed in a PARAMS object of the REQUEST). In case a request parameter is a complex parameter (e.g. a STRUCT) there will be no deep recursion into that parameter.}} |
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Return names of all request parameters of diagnostic services}} | {{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Return names of all request parameters of diagnostic services}} | ||
| Line 21: | Line 18: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| DiagService | [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] | [[Term]] | - | [1] | This element represents the diagnostic service whose request parameters | + | {{TableRowPropertie2| DiagService | [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] | [[Term]] | - | [1] | This element represents the diagnostic service whose request parameters will be listed.}} |
|} | |} | ||
| Line 34: | Line 31: | ||
/// Flow | /// Flow | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false); |
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | ||
List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1); | List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1); | ||
Latest revision as of 10:33, 12 September 2019
Contents
Classification
| Name | GetRequestParameterList |
| Short Description | Return names of all request parameters of diagnostic services |
| Class | Term |
| Extension | OTX DiagDataBrowsing extension |
| Group | DiagDataBrowsing terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ListTerm DiagDataBrowsing.GetRequestParameterList(DiagServiceTerm DiagService);Description
GetRequestParameterList returns a list of strings containing the names of all request parameters of a given diagnostic service.
NOTE — In the case of a MVCI/ODX based system, the returned list will contain the SHORT-NAMEs of all PARAM objects (enclosed in a PARAMS object of the REQUEST). In case a request parameter is a complex parameter (e.g. a STRUCT) there will be no deep recursion into that parameter.
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 | Return names of all request parameters of diagnostic services |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| DiagService | DiagService | Term | - | [1] | This element represents the diagnostic service whose request parameters will be listed. |
OTL Examples
/// Local Declarations
List<String> List1;
DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1);See also
GetComChannelList
GetEcuVariantList
GetDiagServiceList
GetResponseParameterList
GetAllowedParameterValueList
