EPLAN.EPLAN21.DEVICETAGWIZARD.OPEN

Contents

Description

Command for opening the device tag wizard (DTW). The DTW is initialized with the format string of a device to identify changes in the device tag made by the EPLAN.EPLAN21.DEVICETAGWIZARD.CHANGE command and to replace the respective device properties directly. To close the DTW, the EPLAN.EPLAN21.DEVICETAGWIZARD.CLOSE command has to be called up. Only one DTW can be opened by the command.

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

Parameters

All parameters have the prefix "EPL_PARAM_DEVICETAGWIZARD_"!

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

ParameterID Type Description
FORMAT [IN]
String
Format string from which the device tag is to result.
PROJECT [IN]
EplHandle
Project handle of the device.
PAGE [IN]
EplHandle
Page handle of the device.
INSTANCE [IN]
EplHandle
Handle of the device.

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_ALLREADY_OPEN The DT Wizard is already open.
EPL_ERR_DEVICETAGWIZARD_INVALID_FORMATSTRING The format string cannot be parsed.

Reference