Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
CmpDynamicText Library Documentation ¶ Company System Title CmpDynamicText Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpDynamicText Description 1 ¶ This library provides access to the dynamic text component in the runtime system. Contents: ¶ DynamicTextChangeLanguage (Function) DynamicTextGetCurrentLanguage (Function) DynamicTextGetDefaultText (Function) DynamicTextGetDefaultTextW (Function) DynamicTextGetText (Function) DynamicTextGetTextW (Function) DynamicTextIterateIndices (Function) DynamicTextLoadDefaultTexts (Function) DynamicTextRegisterFile (Function) DynamicTextRegisterPath (Function) DynamicTextReloadTexts (Function) DynamicTextUnRegisterFile (Function) Indices and tables ¶ 1 Based on CmpDynamicText.library, last modified 20.04.2021, 15:39:29. LibDoc 4.4.0.0-b.27 The content file CmpDynamicText.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:39:29.
DynamicTextChangeLanguage (FUN) ¶ FUNCTION DynamicTextChangeLanguage : BOOL This function changes the language in the CmpDynamicText component. The CmpDynamicText component loads the texts in this language into memory And returns the texts from this language in DynamicTextGetText and InOut: Scope Name Type Return DynamicTextChangeLanguage BOOL Input stLanguage STRING
DynamicTextGetCurrentLanguage (FUN) ¶ FUNCTION DynamicTextGetCurrentLanguage : STRING This method returns the name of the currently loaded language if there is any. If no language is loaded (there was no call to DynamicTextChangeLanguage before), then an empty string will be returned. InOut: Scope Name Type Return DynamicTextGetCurrentLanguage STRING
DynamicTextGetDefaultTextW (FUN) ¶ FUNCTION DynamicTextGetDefaultTextW : POINTER TO STRING This function retrieves the specified text from the runtime. The text will be returned as a IEC-WString (short* in the runtime) InOut: Scope Name Type Return DynamicTextGetDefaultTextW POINTER TO STRING Input pstTextList POINTER TO STRING pstTextIndex POINTER TO STRING
DynamicTextGetDefaultText (FUN) ¶ FUNCTION DynamicTextGetDefaultText : POINTER TO STRING This function retrieves the specified text from the runtime. The text will be returned as a IEC-String (char* in the runtime) InOut: Scope Name Type Return DynamicTextGetDefaultText POINTER TO STRING Input pstTextList POINTER TO STRING pstTextIndex POINTER TO STRING
DynamicTextGetText (FUN) ¶ FUNCTION DynamicTextGetText : POINTER TO STRING This function retrieves the specified text from the runtime. The text will be returned as a IEC-String (char* in the runtime) InOut: Scope Name Type Return DynamicTextGetText POINTER TO STRING Input pstTextList POINTER TO STRING pstTextIndex POINTER TO STRING
DynamicTextGetTextW (FUN) ¶ FUNCTION DynamicTextGetTextW : POINTER TO STRING This function retrieves the specified text from the runtime. The text will be returned as a IEC-WString (short* in the runtime) InOut: Scope Name Type Return DynamicTextGetTextW POINTER TO STRING Input pstTextList POINTER TO STRING pstTextIndex POINTER TO STRING
DynamicTextIterateIndices (FUN) ¶ FUNCTION DynamicTextIterateIndices : RTS_IEC_RESULT This function can be used to iterate over all indices of a given textlist. An according callback will be called once for each entry in the textlist. Please remark: The order of the entries that are returned may be undefined. InOut: Scope Name Type Comment Return DynamicTextIterateIndices RTS_IEC_RESULT Input pstTextList POINTER TO STRING The name of the textlist that should be iterated pfIterationCallback POINTER TO BYTE The callback function that will be called for every index in the textlist The expected signature is a function returning BOOL with two arguments: a POINTER TO STRING argument reflecting an ID within the textlist. The given POINTER should not be stored for time longer than the overall iteration and the POINTER should not be dereferenced directly but instead it should be copied to a temporary variable before access. a __UXINT value reflecting the value passed in iterationData If the callback function returns FALSE, then the iteration will be cancelled. iterationData __UXINT User provided value that will transparently be passed to all calls of pfIterationCallback
DynamicTextLoadDefaultTexts (FUN) ¶ FUNCTION DynamicTextLoadDefaultTexts : RTS_IEC_RESULT This function loads the default texts from the currently registered text files. as a IEC-String (char* in the runtime) InOut: Scope Name Type Return DynamicTextLoadDefaultTexts RTS_IEC_RESULT