EPLAN.EPLAN21.FORMGEN.REGENERATE

Contents

Description

Command for regenerating pages via the form generator of EPLAN 21.

Parameters

The following parameters have the EPL_PARAM_FORMGEN_ prefix.

ParameterID Type Description
GENERATE_BASE_PROJECT [IN]
EplHandle
Handle to the project in which the pages are to be overwritten.
REGENERATE_RUNID [IN]
Integer
ID of the generation run which is to be updated.
GENERATE_BASE_NEW_RUNID [OUT]
Integer
ID of the generation run just completed or 0 not set when the run has been completed.

Error Messages

The eplExecuteCommand function returns EPL_OK if the pages could be successfully regenerated.

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_GENERAL An unexpected exception error has occurred.
EPL_ERR_CANCELED The process was aborted by the user.
EPL_ERR_FG_FORM_INVALID No form could be found for the form name specified.
EPL_ERR_FG_FORMTYPE_INVALID The specified form has a form type not supported by the form generator (form property 6001). The creator of the form can enter any page type as the type: however, only a subset of all the page types can be processed by the form generator. Example: Forms of the "Free graphics" form type cannot be used for generation.
EPL_ERR_FG_PROJECT_INVALID The project handle is invalid.
EPL_ERR_FG_RUNID_INVALID No pages of the specified generation-run ID could be found.
EPL_ERR_NO_RIGHT The current user group does not allow for using the Form generator or modifying and creating pages.

Example

void generatePage(EplSession s)
{
        EplHandle cmd = eplCreateCommand(s,
                L"EPLAN.EPLAN21.FORMGEN.REGENERATE");

        //Set parameters  ...

        if (eplExecuteCommand(s, cmd) == EPL_OK)
        {
                // Read out return parameters ...
        }

        eplCloseObject(cmd);
}

Reference