Extensions.DiagDataBrowsingPlus.GetDbParameterDefaultValueAsString

From emotive
Jump to navigation Jump to search

Classification

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

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbParameterDefaultValueAsString(DbParameterTerm dbParameter);

Description

GetDbParameterDefaultValueAsString returns the compu default value of the parameter as string.

If the parameter is a complex data type, the default value of the parameter can not be determined and the parameter type is NRC-CONST, the InvalidTypeException exception will be thrown.

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

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
String Returns the compu default value of the parameter.

Properties

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

OTL Examples

/// Local Declarations

DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
String MyString;

/// Flow

Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentActuaTestStatu")), {"Param_RequeServiId"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
MyString = DiagDataBrowsingPlus.GetDbParameterDefaultValueAsString(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter