QPR Knowledge Base 2014.1

ChangeCurrentModelingLanguage

ChangeCurrentModelingLanguage

Previous topic Next topic  

ChangeCurrentModelingLanguage

Previous topic Next topic JavaScript is required for the print function  

Revision history:

Introduced in QPR 7.4.1 SP1

Last changed in QPR 2012.2

 

Changes the currently active modeling language to the language supplied as a parameter.

 

Synopsis:

 

PGModel.ChangeCurrentModelingLanguage(Language)

 

Parameters:

 

Language: Integer/String. Either a language ID (integer) or a language code (string). The language code is supplied in QPR Modeling Client when adding languages available as modeling languages.

In the case the value is empty, the current modeling language is used.

If LanguageID is 0 or -1, the current modeling language is used.

If LanguageID is -2, the default modeling language is used.

 

Required Rights:

 

View rights to the diagram.

 

Return Values:

Below are listed the return values that this function can return:

 

RV_SUCCESS

RV_APPLICATION_QUIT_CALLED

RV_MODEL_NOT_OPEN

RV_MODEL_DOES_NOT_USE_MULTILINGUAL_MODELING

RV_LANGUAGEID_NOT_FOUND

RV_FUNCTION_CANNOT_BE_USED_IN_VALIDATION_SCRIPT

 

Example Procedure:

 

Sub ChangeLanguage()

 dim iResult

 

 iResult = PGModel.ChangeCurrentModelingLanguage("FIN")

 If iResult <> 0 Then

   MsgBox "Call failed: " + PGApplication.GetErrorMessage(iResult)

 End If

End Sub