EPLAN.EPLAN21.PROJECT.CLEAR_MARKERS

Contents

Description

Command for removing the revision markers from the project.

The EPLAN.EPLAN21.PROJECT.CLEAR_MARKERS command is called up via the API functions as specified in the EPLAN 21 API.

The command removes the revision markers from the following objects:

Parameters

All parameters have the prefix "EPL_PARAM_REVISION_CLEARMARKER_"!

ParameterID Type Description
PROJECT [IN]
Handle
Handle of the project.

Error Messages

The eplExecuteCommand function returns EPL_OK if the command could be successfully 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_REVISION_PROJECT_READONLY The project is write-protected.

Example

The following example shows a function that uses this command.

EplHandle
createMarkers(EplSession hSession, EplHandle hProject)
{
        EplHandle hRet(EPL_ERROR);

        EplHandle hCmd = eplCreateCommand(hSession, L"EPLAN.EPLAN21.PROJECT.CLEAR_MARKERS");

        if(hCmd != EPL_ERROR)
        {
                eplSetHandleParam(hSession, hCmd, EPL_PARAM_REVISION_CLEARMARKER_PROJECT, hProject, 0);

                hRet = eplExecuteCommand(hSession, hCmd);

                eplCloseObject(hSession, hCmd);
        }

        return hRet;
}

Reference