Notifications

This reference contains all the notifications that are available for the EPLAN 21 API.

Notification

Short Description

EPLAN.EPLAN21.NOTIFICATION.PROGRESS

Progress information can be controlled from within commands via the API


 

EPLAN.EPLAN21.NOTIFICATION.OBJECT_CHANGE

This notification is raised when modifications have been made at DT or component properties on the EPLAN user interface.
Note: Modifications made via the API (e.g. via eplSetProperty) are not reported.

Parameters

All parameters have the prefix "EPL_PARAM_NOTIFICATION_OBJECT_CHANGE_".

ParameterID Type Description
OBJECT Handle Object that was modified.
PROP_ITER_NEW Handle Iterator for the new properties of the object. Contains at least all modified properties.
PROP_ITER_OLD Handle Iterator for the old properties of the object. Contains at least all modified properties.
 

EPLAN.EPLAN21.NOTIFICATION.PROGRESS

Using this notification, progress information can be controlled from within commands via the API.

Parameters

All parameters have the prefix "EPL_PARAM_NOTIFICATION_PROGRESS_".

ParameterID Type Description
ID INT ID of the progress that is to receive the notification.
FUNCTIONID INT The function ID can assume the following values:
0 - Set progress to value SPENT
1 - Set text in progress to TEXT
2 - Prompt whether Cancel was pressed in the progress
TEXT STRING Text to be set in the progress.
SPENT FLOAT Value between 0 and 100 to which the progress is to be set.
CANCELED [OUT] BOOL If Cancel was pressed in the progress, the notification returns true in CANCELED, otherwise false.