Methods for Read Access (CL_APL_ECATT_PARAMS_API)
Use
This category contains the following methods:
GET_PARAMS
Writes the parameter list to a local variable. GET_PARAMS is called by the method CHECK_PARAMETER_EXIST, which checks the existence of the relevant parameter.
CHECK_PARAMETER_EXIST
This method checks the existence of a parameter.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_PARAM_NAME |
ETP_NAME |
Name of a parameter or a command interface |
|
|
R_EXISTS |
ETONOFF |
Indicator for checking the existence of a parameter |
CHECK_DEFAULT_VARIANT
This method reads the default variant data.
GET_PARAM_NAMES
This method returns the list of defined parameters.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_SORTORDER |
ETONOFF |
'X' |
Sequence
|
|
E_PARAM_TAB |
ETP_NAME_TABTYPE |
Table with parameter names |
GET_PARAM_DEFINITION
This method returns the definition of a parameter.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_PARAM_NAME |
ETP_NAME |
Name of a parameter or a command interface |
|
|
E_PARAM_DEF |
STRING |
Parameter definition |
GET_VALUE_INTERNAL
This method transfers a parameter value from the TDC to the REF memory area.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_PARAM_NAME |
ETPAR_NAME |
Parameter name |
|
|
I_VARIANT_NAME |
ETVAR_ID |
Variant name |
|
|
I_PATH |
STRING |
Parameter path |
|
|
E_PARAM_REF |
DATA |
REF of the variable to which the value is to be transferred |
GET_VALUE
This method returns the value of a variant.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_PARAM_NAME |
ETPAR_NAME |
Parameter name |
|
|
I_VARIANT_NAME |
ETVAR_ID |
Variant name |
|
|
I_PATH |
STRING |
Parameter path |
|
|
E_PARAM_VALUE |
ANY |
Variable into which the value is to be transferred |
CHECK_PARAMETER_TYPE
This method checks whether a parameter is simple or structured.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_PARAM_NAME |
ETP_NAME |
Name of a parameter or a command interface |
|
|
RE_SIMPLE |
ETONOFF |
eCATT switch on/off |