EPLAN.EPLAN21.DISPLAY_LANGUAGE.REMOVE

Contents

Description

Command for removing languages from the list of displayed languages.

Parameters

ParameterID Type Description
EPL_PARAM_DISPLAY_LANGUAGES [IN]
String
This parameter contains the languages to be removed from the list of displayed languages in the form of a string. The languages are specified by the country code. If the parameter contains more than one language, the codes will be entered directly one after the other without a separator.

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_GENERAL An unexpected exception error has occurred.

Example

The following simple example shows a function that removes the English and German languages from the list of displayed languages.

void removeDisplayLanguages(EplSession hSession)
{
       EplHandle hCmd = eplCreateCommand(hSession,
                                        L"EPLAN.EPLAN21.DISPLAY_LANGUAGE.REMOVE");

       // Have the German and the English text displayed:
       eplSetParam(hSession,
                   hCmd,
                   EPL_PARAM_DISPLAY_LANGUAGES,
                   L"DEEN",
                   0);
       eplExecuteCommand(hSession, hCmd);
       eplCloseObject(hSession, hCmd);
}

Reference