Command for inserting a line into a page.
The EPLAN.EPLAN21.LINE.CREATE command is called up via the API functions as specified in the EPLAN 21 API.
All parameters have the prefix "EPL_PARAM_GRAPHIC_CREATE_".
ParameterID | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PAGE | [IN] EplHandle |
Handle to the page into which the line is to be inserted. | ||||||||||||||||||||||||||||||||||||||||||||||||
XPOS | [IN] Integer |
X-coordinate of the starting point of the line. | ||||||||||||||||||||||||||||||||||||||||||||||||
YPOS | [IN] Integer |
y-coordinate of the starting point of the line. | ||||||||||||||||||||||||||||||||||||||||||||||||
PENWIDTH | [IN] Integer |
Pen width | ||||||||||||||||||||||||||||||||||||||||||||||||
DELTA_X | [IN] Integer |
Spacing of the end point of the line on the x-axis | ||||||||||||||||||||||||||||||||||||||||||||||||
DELTA_Y | [IN] Integer |
Spacing of the end point of the line on the x-axis | ||||||||||||||||||||||||||||||||||||||||||||||||
COLOR | [IN, OPTIONAL] Integer |
Line color:
|
||||||||||||||||||||||||||||||||||||||||||||||||
STYLE | [IN, OPTIONAL] Integer |
Line style:
|
||||||||||||||||||||||||||||||||||||||||||||||||
RESULT | [OUT] EplHandle |
After execution of the command, this parameter can be used to query the handle of the created line. |
The eplExecuteCommand function returns EPL_OK if the line could be successfully inserted into the page.
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 page. |
EPL_ERR_FAILED | The line could not be created. |
EPL_ERR_INVALID_ARGUMENT | The PAGE parameter is not an object of the Page type. |
The following example shows a function which inserts a line into a page. The handle to the page object must be determined first.
EplHandle createLine(EplSession s, EplHandle page) { EplHandle hRet(EPL_ERROR); //Create command EplHandle cmdCreateLine = eplCreateCommand(s, L"EPLAN.EPLAN21.LINE.CREATE"); if(cmdCreateLine != EPL_ERROR) { //Set parameters // //Page handle eplSetHandleParam(s, cmdCreateLine, EPL_PARAM_GRAPHIC_CREATE_PAGE, page, 0); //Pen size eplSetParam(s, cmdCreateLine, EPL_PARAM_GRAPHIC_CREATE_PENWIDTH, L"1", 0); //Pen color eplSetParam(s, cmdCreateLine, EPL_PARAM_GRAPHIC_CREATE_COLOR, L"7", 0); //X/Y coordinates of line start eplSetParam(s, cmdCreateLine, EPL_PARAM_GRAPHIC_CREATE_XPOS, L"100000", 0); eplSetParam(s, cmdCreateLine, EPL_PARAM_GRAPHIC_CREATE_YPOS, L"100000", 0); //X/Y gradient eplSetParam(s, cmdCreateLine, EPL_PARAM_GRAPHIC_CREATE_DELTA_X, L"10000", 0); eplSetParam(s, cmdCreateLine, EPL_PARAM_GRAPHIC_CREATE_DELTA_X, L"10000", 0); //Execute command if(eplExecuteCommand(s, cmdCreateLine) = EPL_OK) { // Query result: hRet = eplGetHandleParam(s, cmdCreateLine, EPL_PARAM_GRAPHIC_CREATE_RESULT, 0); } eplCloseObject(s, cmdCreateLine); } return hRet; } |