GetLanguageTextNonBlocking (FUN)ΒΆ

FUNCTION GetLanguageTextNonBlocking : ReturnValues

This function returns the language specific text of a textlist as STRING. This function does not block and returns the error ReturnValues.ERR_LOCKED if access to the text was not possible at the current time. To obtain the text, the function must be called until ReturnValues.ERR_OK is returned.

Note

The desired language must be loaded with CmpDynamicText.DynamicTextLoadLanguage(sLanguage) before the function GetLanguageText is called. For performance reasons, the language should not be loaded/unloaded cyclically. The best way is to load the language after the application has been initialized or when a language change is necessary. The language should be unloaded with CmpDynamicText.DynamicTextUnloadLanguage(sLanguage) when the language texts are not needed anymore.

InOut:

Scope

Name

Type

Comment

Return

GetLanguageTextNonBlocking

ReturnValues

Possible last error values:

see ReturnValues (ENUM) where possible error reasons are described.

Inout Const

sTextList

STRING

The textlist name

sTextIndex

STRING

The textlist id

sLanguage

STRING

In which language the text should be returned

Input

psText

POINTER TO STRING

The buffer where the result text should be returned

diSize

DINT

The size of the parameter psText in byte (SIZEOF() can be used)

Output

bDefaultText

BOOL

Indicates if the default text is used