UserMgrObjectSetGroupRights (FUN) ¶ FUNCTION UserMgrObjectSetGroupRights : RTS_IEC_RESULT Set the access rights for the group at the specified object InOut: Scope Name Type Comment Return UserMgrObjectSetGroupRights RTS_IEC_RESULT Error code ERR_OK: Access rights could be set ERR_PARAMETER: Invalid handles ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user hObject RTS_IEC_HANDLE Handle to the object hGroup RTS_IEC_HANDLE Handle to the group ulRights DWORD Rights of the group. See category “User rights” for details
UserMgrObjectSetUsedRights (FUN) ¶ FUNCTION UserMgrObjectSetUsedRights : RTS_IEC_RESULT Sets the used access rights for the object specified by handle. The rights are additionally stored in an internal list. In case USERDB_RIGHT_NONE is passed for ulUsedRights the previously stored rights are retrieved for this object. Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectSetUsedRights RTS_IEC_RESULT Error code ERR_OK: Rights are successfully set ERR_PARAMETER: Invalid object handle ERR_NO_OBJECT: Object was not found for rights retrieval ERR_NO_ACCESS_RIGHTS: No access rights in IEC context Input hObject RTS_IEC_HANDLE Handle to the object ulUsedRights DWORD Used access rights or USERDB_RIGHT_NONE for retrieval
Userhandling ¶ UserMgrUserAdd (Function) UserMgrUserAddInfoToUser (Function) UserMgrUserGetFirst (Function) UserMgrUserGetInfoOfUser (Function) UserMgrUserGetName (Function) UserMgrUserGetNext (Function) UserMgrUserGetProperty (Function) UserMgrUserRemove (Function) UserMgrUserRemoveInfoFromAllUsers (Function) UserMgrUserRemoveInfoFromUser (Function) UserMgrUserSetCredentials (Function) UserMgrUserSetProperty (Function)
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.
