UserMgrUserAdd (FUN) ¶ FUNCTION UserMgrUserAdd : RTS_IEC_RESULT Add a new user to the user database InOut: Scope Name Type Comment Return UserMgrUserAdd RTS_IEC_RESULT Error code ERR_OK: User could be added ERR_DUPLICATE: User already exists ERR_PARAMETER: Invalid parameter. pszUser empty ERR_NOMEMORY: No memory available to store new user ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszUser STRING User name, limited to 59 chars pCredentials UserMgrCredentials Credentials, only password is available so far, password (plain text) is limited to 59 chars
UserMgrUserAddInfoToUser (FUN) ¶ FUNCTION UserMgrUserAddInfoToUser : RTS_IEC_RESULT Adds an value to an logged in user. This can be used as some kind of cache that exists as long as the user is logged in. InOut: Scope Name Type Comment Return UserMgrUserAddInfoToUser RTS_IEC_RESULT ERR_OK: Value cached; ERR_DUPLICATE: The same key has been used already; ERR_FAILED: The caching failed Input hUser RTS_IEC_HANDLE Handle to authorized user key __XWORD Access key for the cache value. This has to be used at UserMgrGetInfoOfUser to access the value. value UserMgrCacheValue Value to cache at the user.
UserMgrUserGetFirst (FUN) ¶ FUNCTION UserMgrUserGetFirst : RTS_IEC_RESULT Iteration interface to get the first user InOut: Scope Name Type Comment Return UserMgrUserGetFirst RTS_IEC_RESULT Error code ERR_OK: First user available ERR_NO_OBJECT: No user configured ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout phIterator RTS_IEC_HANDLE Iteration handle to use with UserMgrUserGetNext() pszUsername STRING(59) Buffer to store the name, 59 chars max Output UserProperty DWORD User properties. See category ‘User and group properites’
UserMgrUserGetInfoOfUser (FUN) ¶ FUNCTION UserMgrUserGetInfoOfUser : DWORD Retrieves the value cached using UserMgrAddInfoToUser. InOut: Scope Name Type Comment Return UserMgrUserGetInfoOfUser DWORD ERR_OK: Retrieving cache value successful; ERR_PARAMETER: Some parameter is invalid; ERR_NO_OBJECT: No cache value with this key available. Input hUser RTS_IEC_HANDLE Handle to authorized user key __XWORD Key of the cache value. Output value UserMgrCacheValue Value from the cache
UserMgrUserGetName (FUN) ¶ FUNCTION UserMgrUserGetName : RTS_IEC_RESULT Get user name from a user handle InOut: Scope Name Type Comment Return UserMgrUserGetName RTS_IEC_RESULT Error code ERR_OK: User name copied ERR_INVALID_HANDLE: hUser not a valid user handle. Input hUser RTS_IEC_HANDLE Handle to authorized user Inout pszUsername STRING(59) Buffer to store the name, 59 chars max
X509CertInfoExit (FUN) ¶ FUNCTION X509CertInfoExit : RTS_IEC_RESULT Cleanup an RtsX509CertInfo structure. All allocated memory used by this strucutre will be release. InOut: Scope Name Type Comment Return X509CertInfoExit RTS_IEC_RESULT Result of the operation Input pCertInfo POINTER TO RtsX509CertInfo Pointer to the object to clean up.
X509CertInfoInit (FUN) ¶ FUNCTION X509CertInfoInit : RTS_IEC_RESULT Initialize the RtsX509CertInfo structure. InOut: Scope Name Type Comment Return X509CertInfoInit RTS_IEC_RESULT Result of the operation Input pCertInfo POINTER TO RtsX509CertInfo Pointer to the structure. structSize UDINT Size of the structure.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 02.03.2023, 11:03:44 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpX509Cert Implementation.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpX509Cert Implementation.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool False Released True LastModificationDateTime date 02.03.2023, 11:03:42 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace Description See: Description DocFormat reStructuredText Placeholder CmpX509Cert Implementation Project CmpX509Cert Implementation Title CmpX509Cert Implementation Version version 3.5.19.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpCrypto Interfaces ¶ Library Identification ¶ Name: CmpCrypto Interfaces Version: newest Company: System Namespace: CmpCrypto_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto Interfaces, * (System) CmpX509Cert Interfaces ¶ Library Identification ¶ Name: CmpX509Cert Interfaces Version: newest Company: System Namespace: CmpX509Cert_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpX509Cert Interfaces, * (System) SysSocket Interfaces ¶ Library Identification ¶ Name: SysSocket Interfaces Version: newest Company: System Namespace: SysSocket_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSocket Interfaces, * (System) SysTime ¶ Library Identification ¶ Name: SysTime Version: 3.5.9.0 Company: System Namespace: SysTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTime, 3.5.9.0 (System) 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)
Collections Library Documentation ¶ Company System Title Collections Version 3.5.17.0 Categories Intern|DataServer Author 3S-Smart Software Solutions GmbH Placeholder Collections Description 1 ¶ This library contains some collections and baseclasses to easily create own collections for some types. Contents: ¶ AbstrTreeNode (FunctionBlock) ChildCount (Property) GetChild (Method) GetFather (Method) IBase Sorted (Property) abstrNodeType (Property) proChildren (Property) BaseMap (FunctionBlock) BeginUpdate (Method) EndUpdate (Method) proUseOptimizedSortForInsertionAtTheEnd (Property) BaseVector (FunctionBlock) Capacity (Property) Clear (Method) Count (Property) InitMemory (Method) RemoveLast (Method) ReserveSpace (Method) proAfterAlloc (Method) proRemove (Method) BranchNamedTreeNode (FunctionBlock) ChildCount (Property) proChildren (Property) CaseSensitiveNamedTreeNode (FunctionBlock) CaseSensitiveComparison (Property) DintToDintMap (FunctionBlock) AddDintPair (Method) GetValue (Method) DintVector (FunctionBlock) AddDint (Method) GetDint (Method) DwordVector (FunctionBlock) AddDword (Method) GetDword (Method) Remove (Method) GVL_DebugOnlyCollections (GVL) Globals (GVL) InstancePathBuildingBranchNode (FunctionBlock) ChildCount (Property) InstancePathNodeType (Property) proChildren (Property) InstancePathBuildingNode (FunctionBlock) GetFullPath (Method) IBase InstancePathNodeType (Property) InstancePathNodeFinder (FunctionBlock) Find (Method) FindLong (Method) FindLongWithData (Method) FindWithData (Method) Initialize (Method) abstrIgnoreRootNode (Method) abstrNodeFound (Method) abstrNodeNotFound (Method) protCallNodeFoundForRootNode (Property) protCallNodeNotFoundForRootNode (Property) MemBuffer (FunctionBlock) Alloc (Method) CanResize (Method) FB_Exit (Method) InitStatic (Method) Resize (Method) NamedTreeNode (FunctionBlock) CaseSensitiveComparison (Property) FindChildByName (Method) IBase Name (Property) PStringToDintMap (FunctionBlock) AddPStringDintPair (Method) CaseSensitive (Property) Clear (Method) CopyStrings (Property) FB_Exit (Method) GetIndex (Method) GetKeyByIndex (Method) GetValue (Method) GetValueByIndex (Method) Remove (Method) SetValueByIndex (Method) PStringToXWORDMap (FunctionBlock) AddPStringXWORDPair (Method) CaseSensitive (Property) Clear (Method) CopyStrings (Property) FB_Exit (Method) GetIndex (Method) GetKeyByIndex (Method) GetValue (Method) GetValueByIndex (Method) Remove (Method) SetValueByIndex (Method) PStringVector (FunctionBlock) AddString (Method) GetString (Method) Pair_DintDint (Struct) Pair_PStringDint (Struct) Pair_PStringXWORD (Struct) Pair_StringDint (Struct) Pair_StringString (Struct) SortedBranchNamedTreeNode (FunctionBlock) Sorted (Property) SortedInstancePathBuildingBranchNode (FunctionBlock) Sorted (Property) SortedPStringVector (FunctionBlock) AddPString (Method) CaseSensitive (Property) GetPString (Method) StaticMemBuffer (Struct) StringBuilder (FunctionBlock) AppendChar (Method) AppendPString (Method) AppendString (Method) Capacity (Property) Clear (Method) GetPStringResult (Method) InitMemory (Method) Length (Property) ReserveSpace (Method) prvAppend (Method) StringFunctions PStrCat (Function) PStrCmp (Function) PStrICmp (Function) PStrIFind (Function) PStrLen (Function) PStrLenUntil (Function) PStrToUpper (Function) StringToDintMap (FunctionBlock) AddStringDintPair (Method) CaseSensitive (Property) GetValue (Method) StringToStringMap (FunctionBlock) AddStringStringPair (Method) CaseSensitive (Property) GetValue (Method) abstrAssign (Method) StringVector (FunctionBlock) AddString (Method) GetString (Method) RemoveAt (Method) UtilTokenizer (FunctionBlock) CurrentPosition (Property) Initialize (Method) NextToken (Method) XwordVector (FunctionBlock) AddXword (Method) FB_Exit (Method) GetXword (Method) Remove (Method) Indices and tables ¶ 1 Based on Collections.library, last modified 20.04.2021, 14:41:10. LibDoc 4.4.0.0-b.27 The content file Collections.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 14:41:10.
