EPLAN.EPLAN21.PART_SYMBOL.REGENERATE

Contents

Description

Command for updating a mounting-panel page.

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

Parameters

All parameters have the prefix "EPL_PARAM_PART_SYMBOL_REGENERATE_".

ParameterID Type Description
PAGE [IN]
EplHandle
Handle of the mounting-panel page to be updated.
PAGES [IN]
EplHandle
Handle of an iterator for mounting-panel pages to be updated.
LIST_INVALID [OUT, index]
EplHandle
Handles of iterators for invalid instances.
LIST_VALID [OUT, index]
EplHandle
Handles of iterators for valid instances.

Error Messages

The eplExecuteCommand function returns EPL_OK if the objects could be successfully printed.

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_FAILED The symbol could not be inserted.
EPL_ERR_INVALID_ARGUMENT No suitable parameter (PAGE, PAGES) was given.

Example

bool
partSymbolRegenerate(        EplSession hSession,
                      EplHandle hPage)
{
        bool bRet(false);

        if(hSession != EPL_ERROR)
        {
                //hPage is to be updated
                //Create command
                EplHandle hCmdPartSymbolRegenerate = eplCreateCommand(hSession, L("EPLAN.EPLAN21.PART_SYMBOL.REGENERATE"));

                if((hCmdPartSymbolRegenerate != EPL_ERROR) &&
                   (hPart != EPL_ERROR))
                {
            const BUFLEN = 100;
            wchar_t buf[BUFLEN];

            //Fill parameters
            //Page

            eplSetHandleParam(hSession,
                              hCmdPartSymbolRegenerate,
                              EPL_PARAM_PART_SYMBOL_REGENERATE_PAGE,
                              hPage,
                              0);

            //Execute command
                        if( eplExecuteCommand(hSession, hCmdPartSymbolRegenerate) != EPL_ERROR)
            {
                            bRet = true;
            }
               }
        }

        return bRet;
}

Reference