EPLAN.EPLAN21.DEVICETAGWIZARD.PARSE

Contents

Description

Command for parsing strings that result from a format string, such as the device tag. All properties of the character string are determined that exist in the format string. In addition there is the option to directly set properties during parsing.

The EPLAN.EPLAN21.DEVICETAGWIZARD.PARSE command is called up via the API functions as 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. for each one a list of values is returned. Index = 0 always contains the number of values.

ParameterID Type Description
NAME [IN]
String
Name to be parsed.
FORMAT [IN]
String
Format from which the name is to result
PROJECT [IN]
EplHandle
Project handle
PAGE [IN]
EplHandle
Page handle
INSTANCE [IN]
EplHandle
Instance handle
PROPTOKEN_SET_VALUE [IN, OPTIONAL]
Boolean
Specifies whether the determined property values are to be taken over after the parsing.
(0) Do not set properties (default)
(1) Set properties
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 backup 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_INVALID_FORMATSTRING The format string cannot be parsed.
EPL_ERR_DEVICETAGWIZARD_CANNOT_PARSE_STRING The character string could not be parsed.

Reference