Command for changing the sorting of an interruption-point list. Using this command, paired and stellate interruption points can be re-sorted within a interruption-point list. The EPLAN.EPLAN21.INTERRUPTIONPOINT.RESORT command is called up via the API functions as specified in the EPLAN 21 API. In case of stellate interruption points, the source is the first interruption point on the list. The sort codes of the interruption points are set in a way that the smallest sort code is assigned to the source. The following interruption points are provided with correspondingly higher sort codes. As a rule the project must have left the editing mode. All modifications (in particular modifications in the graphics editor) must have been stored beforehand.
All parameters have the prefix "EPL_PARAM_INTERRUPTIONPOINT_RESORT_"!
ParameterID | Type | Description |
---|---|---|
PROJECT | [IN] EplHandle |
Handle to the project of the interruption-point list. It is required to determine whether the project is still in the editing mode. |
LIST | [IN] EplHandle |
Handle to the interruption-point list to be re-sorted. |
POS | [IN, INDEX] String |
Indexed parameter. Index 0 is to contain the number of valid entries of the parameter, which follow index 0. The value "5" at index 0 means: The indices 1, 2, 3, 4, and 5 follow. The pair IN=1 INDEX=2 means: The second interruption point becomes the first one. Caution: No double values for IN. The values for IN are a permutation of the INDEX values. In case of stellate interruption points, the source is the first interruption point on the list. |
SOURCE_SORTCODE | [IN] int |
Sort code for the source of the interruption-point lists. The default value is 0. The value must be positive. Any value smaller than 0 will be ignored. All sort codes of the following interruption points on the list are higher than SOURCE_SORTCODE. |
The eplExecuteCommand function returns EPL_OK if the interruption-point list could be created successfully.
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_NO_RIGHT | The current user group is not allowed to modify the project. |
EPL_ERR_FAILED | The object could not be re-sorted. |
EPL_ERR_INVALID_ARGUMENT | The LIST parameter is invalid. |
EPL_ERR_INTERRUPTIONPOINT_LIST_COUNT_NOT_OK | The number of indices 1,..,n does not correspond to the number of interruption points on the LIST. |
EPL_ERR_INTERRUPTIONPOINT_LIST_POS_NOT_UNIQUE | The new positions on the list were duplicate or invalid ( <1 or n< ). |
EPL_ERR_INTERRUPTIONPOINT_LIST_UNDO_LIST_OPEN | The project is still in the editing mode and is not saved completely (the undo list is not empty). |
EPL_ERR_INTERRUPTIONPOINT_LIST_NO_PROJECT | The PROJECT parameter is invalid. |
EPL_ERR_NO_UNDO_MANAGER | The project has no undo manager (internal mistake). |
The following example shows a function which re-sorts an interruption-point list.
|