Command for testing schematic pages.
The "EPLAN.EPLAN21.PAGE.CHECK" command is called up via the API functions as specified in the EPLAN 21 API.
All parameters have the prefix "EPL_PARAM_CHECK".
The return parameters are indexed. The n-th message can therefore be accessed by index n. In addition to the ...MESSAGECOUNT parameter, index 0 contains the number of log entries. Access to a non-existing index is recorded in the error log and can be called up via eplGetLastError.
ParameterID | Type | Description |
---|---|---|
PAGE | [IN] EplHandle |
Handle of the page to be checked. |
STATUS | [OUT, INDEX] Integer |
Status of the message:
|
STATUSDESCR | [OUT, INDEX] String |
Status of the message as text. |
PAGEINDEX | [OUT, INDEX] Integer |
Index of the page on which the error occurs. |
X | [OUT, INDEX] Integer |
X coordinate of the element on the page. |
Y | [OUT, INDEX] Integer |
Y coordinate of the element on the page. |
DEVICE | [OUT, INDEX] String |
DT of the element to which the message refers. |
XREF | [OUT, INDEX] String |
Cross-reference. |
COMMENT | [OUT, INDEX] String |
Comment on the message |
MESSAGECOUNT | [OUT] Integer |
Number of messages in log. |
The eplExecuteCommand function returns EPL_OK if the check could be correctly executed.
If the command fails, eplExecuteCommand returns the value EPL_ERROR. In this case, the error log can contain the following errors:
ErrorID | Description |
---|---|
EPL_ERR_INVALID_ARGUMENT | The parameter ...PAGE was not set correctly. |