Extensions.DiagDataBrowsingPlus.GetDbParameterMaxLength

From emotive
Jump to navigation Jump to search

Classification

Name GetDbParameterMaxLength
Short Description Gets the maximum length in bytes of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm DiagDataBrowsingPlus.GetDbParameterMaxLength(DbParameterTerm dbParameter);

Description

GetDbParameterMaxLength returns the maximum length in bytes of the parameter or the maximum count of items. For the parameter types BYTEFIELD, ASCIISTRING and UNICODE2STRING the return value is the maximum length in bytes. For the parameter types eFIELD and eEND_OF_PDU the return value is the maximum count of items.

If the parameter type is one of BYTEFIELD, ASCIISTRING and UNICODE2STRING and the parameter has no length information, the InvalidTypeException exception will be thrown.

Icons Note.png The appropriate MVCI system operation is MCDDbParameter::getMaxLength

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 Returns the maximum length in bytes of the parameter or the maximum count of items.

Properties

Name Data Type Class Default Cardinality Description
DbParameter DbParameter Term - [1..1] The element addresses the DbParameter (MCDDbParameter) which maximum length in bytes shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
Integer MyInteger;

/// Flow

[#MetaData(RequestPdu), <#Data>22 2A 19</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "stall current measurement value"}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor", "Param_StallCurreMeasuValue", "Case_MeasuValue", "Param_Ruhes"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
MyInteger = DiagDataBrowsingPlus.GetDbParameterMaxLength(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter