Command for sending a notification which can be parameterized.
The EPLAN.EPLAN21.NOTIFICATION.SEND command is called up via the API functions as specified in the EPLAN 21 API.
All parameters have the prefix "EPL_PARAM_NOTIFICATION_".
ParameterID | Type | Description |
---|---|---|
NAME | String |
Description of the notification to be sent. This description should be named according to the command name pattern in order to be able to classify the various notifications more easily. |
The eplExecuteCommand function returns EPL_OK if the notification could be sent.
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 transferred name is not valid for notifications. |
The following example shows a function which sends a "PROGRESS" notification.
const BUFLEN=20; void sendProgressNotification(EplSession s, long percent) { EplHandle not = eplCreateCommand(s, "EPLAN.EPLAN21.NOTIFICATION.SEND"); if(not != -1) { wchar_t buf[20]; eplSetParam(s,not,EPL_PARAM_NOTIFICATION_NAME,L"NOTI_TEST",0); eplExecuteCommand(s, not); } eplCloseObject(s, not); } |