UserMgrObjectGetNextChild (FUN) ¶ FUNCTION UserMgrObjectGetNextChild : RTS_IEC_HANDLE Iteration interface to get the next child object in the object tree of the specified father object. Must be started with UserMgrObjectGetFirstChild() Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectGetNextChild RTS_IEC_HANDLE Handle to the next child object or RTS_INVALID_HANDLE if failed Input hFatherObject RTS_IEC_HANDLE Handle to the father object hPrevChild RTS_IEC_HANDLE Handle to the previous child object retrieved by UserMgrObjectGetFirstChild() or subsequent calls of UserMgrObjectGetNextChild() Output Result RTS_IEC_RESULT Error code ERR_OK: Next child object available ERR_PARAMETER: Invalid parameter hFatherObject or hPrevChildObject ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_NO_ACCESS_RIGHTS: No access rights in IEC context

UserMgrObjectGetNextGroup (FUN) ¶ FUNCTION UserMgrObjectGetNextGroup : RTS_IEC_HANDLE Iteration interface to get the next group in the user rights management of the specified object. Must be started with UserMgrObjectGetFirstGroup() InOut: Scope Name Type Comment Return UserMgrObjectGetNextGroup RTS_IEC_HANDLE Handle to the next group of the object in the user rights management or RTS_INVALID_HANDLE if failed Input hUser RTS_IEC_HANDLE Handle to authorized user hObject RTS_IEC_HANDLE Handle to the object hPrevGroup RTS_IEC_HANDLE Handle to the previous group retrieved via UserMgrObjectGetFirstGroup() or subsequent calls of UserMgrObjectGetNextGroup() Output Result RTS_IEC_RESULT Error code ERR_OK: Next group available ERR_PARAMETER: Invalid handles ERR_NO_OBJECT: No next group available ERR_NO_ACCESS_RIGHTS: User not authorized

UserMgrObjectRemove (FUN) ¶ FUNCTION UserMgrObjectRemove : RTS_IEC_RESULT Removes an object from the user management and all its children Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectRemove RTS_IEC_RESULT Error code ERR_OK: Object could be removed ERR_PARAMETER: Invalid object handle ERR_NO_ACCESS_RIGHTS: No access rights in IEC context Input hObject RTS_IEC_HANDLE Handle to object

UserMgrObjectRemoveGroup (FUN) ¶ FUNCTION UserMgrObjectRemoveGroup : RTS_IEC_RESULT Remove a group from the specified object InOut: Scope Name Type Comment Return UserMgrObjectRemoveGroup RTS_IEC_RESULT Error code ERR_OK: Group could be removed 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 that should be removed

UserMgrObjectSetGroupDeniedRights (FUN) ¶ FUNCTION UserMgrObjectSetGroupDeniedRights : RTS_IEC_RESULT Set the denied access rights for the group at the specified object InOut: Scope Name Type Comment Return UserMgrObjectSetGroupDeniedRights 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 ulDeniedRights DWORD Denied rights of the group. See category “User rights” for details

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.