Extensions.DiagDataBrowsingPlus.GetDbParameterMinLength

From emotive
Jump to navigation Jump to search

Classification

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

OTL Syntax

IntegerTerm DiagDataBrowsingPlus.GetDbParameterMinLength(DbParameterTerm dbParameter);

Description

GetDbParameterMinLength returns the minimum length in bytes of the parameter or the minimum count of items. For the parameter types BYTEFIELD, ASCIISTRING and UNICODE2STRING the return value is the minimum length in bytes. For the parameter types eFIELD and eEND_OF_PDU the return value is the minimum 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::getMinLength

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

Properties

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

OTL Examples

/// Local Declarations

DiagCom.Request Request;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
Integer MyInteger;

/// Flow

Request = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "SinglJob_CompoListWrite"));
Parameter = DiagCom.GetParameterByPath(Request, {"IPA_CompoListInput", "Param_CompoListInput"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
MyInteger = DiagDataBrowsingPlus.GetDbParameterMinLength(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter