EPLAN.EPLAN21.DEVICETAGWIZARD.CHANGE

Contents

Description

Command for parsing the device tag resulting from a format string. The EPLAN.EPLAN21.DEVICETAGWIZARD.OPEN command must be called up first with the respective parameter. Parsing successfully means determining all properties of the string and setting them at the device.

The EPLAN.EPLAN21.DEVICETAGWIZARD.CHANGE command is called up via the API functions specified in EPLAN 21 API and is only available if the dtw.erx system expansion has been loaded.

Parameters

All parameters have the prefix "EPL_PARAM_DEVICETAGWIZARD_"!

The output parameters are indexed, i.e. for each one a list of values is returned. Index = 0 always contains the number of values.

ParameterID Type Description
NAME [IN]
String
Device tag to be parsed.
PROPTOKEN_VALUES [OUT, index]
long
Contains property values determined during parsing.
PROPTOKEN_PROPID [OUT, index]
long
Contains IDs of the properties used in the format string.

Error Messages

The eplExecuteCommand function returns EPL_OK if the command could be correctly executed.

If the command fails, eplExecuteCommand returns the value EPL_ERROR. The ERROR_ID of the entries in the error log can be individually queried via the indexed parameter EPL_PARAM_COMMAND_ERROR_ID. The EPL_PARAM_COMMAND_ERROR_DESCRIPTION parameter with identical index contains an error description for the ERROR_ID.

In this case, the error log can contain the following errors:

ErrorID Description
EPL_ERR_GENERAL A system error has occurred.
EPL_ERR_INVALID_ARGUMENT An argument necessary for executing the command was not transferred or does not have the correct type.
EPL_ERR_DEVICETAGWIZARD_NOT_OPEN The DT Wizard is not open.
EPL_ERR_DEVICETAGWIZARD_CANNOT_PARSE_STRING The string could not be parsed.

Reference