Structs ¶ HttpProxySettings (Struct)
HttpProxySettings (STRUCT) ¶ TYPE HttpProxySettings : STRUCT Http proxy settings InOut: Name Type Comment sProxyServer STRING(255) Hostname or IP address of the proxy server. Leave blank if no proxy server is used. uiProxyPort UINT Port of the proxy server sProxyUser STRING Name of the proxy user. Leave blank if no authentication is required. sProxyPassword STRING Password of the proxy user.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 06.05.2024, 08:29:46 companyName string 3S-Smart Software Solutions GmbH libraryFile Web Socket Client SL.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile Web Socket Client SL.clean.json version version 2.0.0.0 ProjectInformation AutoResolveUnbound bool True IsEndUserLibrary True OnlineHelp True Released True SourceLibrary False LastModificationDateTime date 06.05.2024, 08:29:44 LibraryCategories library-category-list Application|Utils Author string CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace WEB_SOCKET Description See: Description DocFormat reStructuredText DocLanguages de,en LanguageModelAttribute qualified-access-only Placeholder Web_Socket_Client_SL Project Web Socket Client SL Title Web Socket Client SL Version version 1.10.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3SLicense ¶ Library Identification ¶ Placeholder: 3SLicense Default Resolution: 3SLicense, * (3S - Smart Software Solutions GmbH) Namespace: _3S_LICENSE Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: 3SLicense CAA FB Factory ¶ Library Identification ¶ Placeholder: CAA FB Factory Default Resolution: CAA FB Factory, * (CAA Technical Workgroup) Namespace: FBF Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA FB Factory CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpCrypto ¶ Library Identification ¶ Placeholder: CmpCrypto Default Resolution: CmpCrypto, * (System) Namespace: CmpCrypto Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog Common Behaviour Model ¶ Library Identification ¶ Placeholder: CBML Default Resolution: Common Behaviour Model, * (3S - Smart Software Solutions GmbH) Namespace: CBML Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CBML Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager Net Base Services ¶ Library Identification ¶ Placeholder: NetBaseSrv Default Resolution: Net Base Services, * (3S - Smart Software Solutions GmbH) Namespace: NBS Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: NetBaseSrv Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard String Util Intern ¶ Library Identification ¶ Placeholder: String_Util_Intern Default Resolution: String Util Intern, * (CODESYS) Namespace: MSU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: String_Util_Intern StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysSocket2 ¶ Library Identification ¶ Placeholder: SysSocket2 Default Resolution: SysSocket2, * (System) Namespace: SysSocket2 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSocket2 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)
XML Utility ¶ Enums ERROR (Enum) ElementType (Enum) Encoding (Enum) READ_MODE (Enum) Function Blocks XMLFindElement (FunctionBlock) XMLFindElementAsync (FunctionBlock) XMLFindElementByStringAsync (FunctionBlock) XMLGetElement (FunctionBlock) XMLGetElementAsync (FunctionBlock) XMLWrite (FunctionBlock) XMLWriteAsync (FunctionBlock) Parameter Param (ParamList) Structs XMLElement (Struct)
Enums ¶ ERROR (Enum) ElementType (Enum) Encoding (Enum) READ_MODE (Enum)
ERROR (ENUM) ¶ TYPE ERROR : Error codes of the XML Utility Attributes: qualified_only InOut: Name Initial Comment NO_ERROR 0 Executed without error TIME_OUT 1 Time out FILE_OPEN_ERROR 2 Could not open file INVALID_HANDLE 3 Open file retuned invalid handle READ_ERROR 4 Could not read file WRITE_ERROR 5 Could not write file SET_POS_FAILED 6 Invalid file position NOT_FOUND 7 Element not found START_TAG_NOT_FOUND 8 Start tag of the element not found NEXT_START_TAG_NOT_FOUND 9 Next start element not found. ELEMENT_EXCEEDS_BUFFERSIZE 10 Element size exceeds buffer size. Increment the value of gc_udiBufferSize . COMMENT_EXCEEDS_BUFFERSIZE 11 Comment size exceeds buffer size. Increment the value of gc_udiBufferSize . BLANK_NOT_FOUND 12 Missing blank between attributes MAX_ELEMENT_SIZE_EXCEEDED 13 Maximum array size of XMLElemnts exceeded DATA_ARRAY_POINTER_IS_NULL 14 Data pointer is null EMPTY_DATASET 15 Empty dataset MAX_VALUE_SIZE_EXCEEDED 16 Maximum value size exceeded. Increment the value of gc_udiMaxValueSize . INVALID_LICENSE 17 No valid license found or demo mode has expired. INVALID_INPUT_MAXELEMENTS 18 No valid udiMaxElements, e.g. udiMaxElements = 0
ElementType (ENUM) ¶ TYPE ElementType : Type of the xml element InOut: Name Initial Comment Element 0 Marks an element CDATAElement 1 Marks an element with CDATA Attribute 2 Marks an attribute of an element Comment 3 Marks an comment NotSet 4 Marks an empty element
Encoding (ENUM) ¶ TYPE Encoding : Encoding of a xml file InOut: Name Initial Comment UTF8 0 UFT-8 encoding UTF16 1 UTF-16 encoding
READ_MODE (ENUM) ¶ TYPE READ_MODE : Read modes InOut: Name Initial Comment ONE_ELEMENT 0 Reads only the specified element CHILDREN_ONLY 1 Reads all child elements of the specified element RECURSIVE 2 Reads all underlying elements of the specified element