EPLAN.EPLAN21.PART_SYMBOL.UPDATE

Contents

Description

This command updates a part symbol (on a mounting panel).

The EPLAN.EPLAN21.PART_SYMBOL.UPDATE 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_UPDATE_"!

ParameterID Type Description
SYMBOL [IN]
EplHandle
Handle of the part symbol to be updated.

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_INVALID_ARGUMENT No suitable parameter (part symbol) was transferred.
EPL_ERR_PAGE_INVALID_PART_SYMBOL The symbol could not be updated.

Example

bool
partSymbolUpdate(     EplSession hSession,
                      EplHandle hPartSymbol)
{
	bool bRet = false;

	if(hSession != EPL_ERROR)  {
		// hPartSymbol is to be updated

		//Create command
		EplHandle hCmd = eplCreateCommand(hSession, L"EPLAN.EPLAN21.PART_SYMBOL.UPDATE");

		if ( hCmd != EPL_ERROR  &&  hPart != EPL_ERROR ) {
			//Set parameters
			eplSetHandleParam(hSession,
							  hCmd,
							  EPL_PARAM_PART_SYMBOL_UPDATE_SYMBOL,
							  hPartSymbol,
							  0);

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

	return bRet;
}

Reference