COPY_TO_STRING (FUN) ¶ FUNCTION COPY_TO_STRING : UDINT Copies an IStringRepresentation into a memory block of a string. Type of the itfString can be IBuilder, IString or just an IStringRepresentation. InOut: Scope Name Type Initial Comment Return COPY_TO_STRING UDINT Input itfString IStringRepresentation pbyValue POINTER TO BYTE Pointer to the first byte of string instance, e.g. pbyValue := ADR(myStringInstance) udiSize UDINT Size of the string in bytes, e.g. udiSize := SIZEOF(myStringInstance) itfCharmap ICharmap 0 The default depends on the project setting for string encoding Output eErrorID ERROR Check error output value for better diagnostics
FROM_STRING (FUN) ¶ FUNCTION FROM_STRING : IString Reads from a string and fills an IString instance InOut: Scope Name Type Initial Comment Return FROM_STRING IString Inout Const sValue STRING(255) Input string to read Input itfString IString IString instance, which is filled with sValue value. itfCharmap ICharmap 0 Default: Windows-1252 / UTF-8 Output eErrorID ERROR Check error output value for better diagnostics
WSTRING ¶ COPY_TO_WSTRING (Function) FROM_WSTRING (Function)
COPY_TO_WSTRING (FUN) ¶ FUNCTION COPY_TO_WSTRING : UDINT Copies an IStringRepresentation into a memory block of a wstring. Type of the itfString can be IBuilder, IString or just an IStringRepresentation. InOut: Scope Name Type Comment Return COPY_TO_WSTRING UDINT Input itfString IStringRepresentation pwValue POINTER TO WORD Encoding UCS-2 Pointer to the first byte of wstring instance, e.g. pbyValue := ADR(myWStringInstance) udiSize UDINT Size of the wstring in bytes, e.g. udiSize := SIZEOF(myWStringInstance) Output eErrorID ERROR Check error output value for better diagnostics
FROM_WSTRING (FUN) ¶ FUNCTION FROM_WSTRING : IString Reads from a wstring and fills an IString instance InOut: Scope Name Type Comment Return FROM_WSTRING IString Inout Const wsValue WSTRING(255) WString to read, Encoding UCS-2 Input itfString IString IString instance, which is filled with wsValue value. Output eErrorID ERROR Check error output value for better diagnostics
Internals ¶ GetDefaultCharmap (Function)
GetDefaultCharmap (FUN) ¶ FUNCTION GetDefaultCharmap : ICharmap InOut: Scope Name Type Return GetDefaultCharmap ICharmap
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 21.06.2023, 11:08:36 companyName string 3S-Smart Software Solutions GmbH libraryFile String Conversions.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile String Conversions.clean.json version version 2.0.0.0 ProjectInformation AutoResolveUnbound bool True Released True LastModificationDateTime date 21.06.2023, 11:08:34 LibraryCategories library-category-list Application|Strings Author string CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Patch 3 DefaultNamespace SCV Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only LibDocContent DocsOnly Placeholder StrConv Project String Conversions Title String Conversions UnitTestingDefine StrConvTesting Version version 4.0.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Immutable String Segments ¶ Library Identification ¶ Placeholder: StringSegs Default Resolution: Immutable String Segments, * (CODESYS) Namespace: STR Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringSegs String Builder Base ¶ Library Identification ¶ Placeholder: StringBuilderBase Default Resolution: String Builder Base, * (CODESYS) Namespace: SBB Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: StringBuilderBase SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem UTF-16 Encoding Support ¶ Library Identification ¶ Placeholder: UTF16 Default Resolution: UTF-16 Encoding Support, * (CODESYS) Namespace: UTF16 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: UTF16 UTF-8 Encoding Support ¶ Library Identification ¶ Placeholder: UTF8 Default Resolution: UTF-8 Encoding Support, * (CODESYS) Namespace: UTF8 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: UTF8
RIGHT (FUN) ¶ FUNCTION RIGHT : IString Returns a specific number of runes of a string, starting from right Returns 0 in case of eErrorID <> ERROR.NO_ERROR See IStringRepresentation ☛ ToIString(itfResource, -TO_LINT(udiCount)) InOut: Scope Name Type Comment Return RIGHT IString Input itfString IString String to be analyzed udiCount UDINT Number of runes itfResource IString The resource that this function is working on. It will contain the result after the function call and will also be returned by this function so it can be used in nested calls. Output eErrorID ERROR