UserMgrGroupGetName (FUN) ¶ FUNCTION UserMgrGroupGetName : RTS_IEC_RESULT Get group name InOut: Scope Name Type Comment Return UserMgrGroupGetName RTS_IEC_RESULT Error code ERR_OK: Group name is returned ERR_PARAMETER: Invalid group handle ERR_BUFFERSIZE: The buffer was too small ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user hGroup RTS_IEC_HANDLE Handle to the group Inout pszGroup STRING(59) Buffer to store the name, 59 chars max

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

UserMgrGroupGetNextUser (FUN) ¶ FUNCTION UserMgrGroupGetNextUser : RTS_IEC_RESULT Iteration interface to get next configured user of the user group. Must be started with UserMgrGroupGetFirstUser() InOut: Scope Name Type Comment Return UserMgrGroupGetNextUser RTS_IEC_RESULT Error code ERR_OK: Next user available ERR_NO_OBJECT: No next user available ERR_PARAMETER: Invalid iterator handle ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user hGroup RTS_IEC_HANDLE Group handle Inout phIterator RTS_IEC_HANDLE Iteration handle to use with next call to UserMgrGroupGetNextUser() pszUsername STRING(59) Buffer to store the name, 59 chars max

UserMgrGroupRemove (FUN) ¶ FUNCTION UserMgrGroupRemove : RTS_IEC_RESULT Remove a group from user group database InOut: Scope Name Type Comment Return UserMgrGroupRemove RTS_IEC_RESULT Error code ERR_OK: Group was successfully removed ERR_NO_OBJECT: Group name does not exist ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszGroupName STRING Name of the group

UserMgrGroupRemoveUser (FUN) ¶ FUNCTION UserMgrGroupRemoveUser : RTS_IEC_RESULT Remove user from a group in the user group database InOut: Scope Name Type Comment Return UserMgrGroupRemoveUser RTS_IEC_RESULT Error code ERR_OK: User could be removed ERR_NO_OBJECT: Group or user name does not exist ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszGroup STRING Group name pszUser STRING User name

Objecthandling ¶ UserMgrObjectAdd (Function) UserMgrObjectAddGroup (Function) UserMgrObjectClearRights (Function) UserMgrObjectGetFirstChild (Function) UserMgrObjectGetFirstGroup (Function) UserMgrObjectGetGroupRights (Function) UserMgrObjectGetHandle (Function) UserMgrObjectGetName (Function) UserMgrObjectGetNextChild (Function) UserMgrObjectGetNextGroup (Function) UserMgrObjectRemove (Function) UserMgrObjectRemoveGroup (Function) UserMgrObjectSetGroupDeniedRights (Function) UserMgrObjectSetGroupRights (Function) UserMgrObjectSetUsedRights (Function)

UserMgrObjectAdd (FUN) ¶ FUNCTION UserMgrObjectAdd : RTS_IEC_HANDLE Adds a new object to the user management, so the access rights can be configured on that object. Limited to the application subtree. Note The name of the object must include the full name-space with “Device” as the root node, e.g. “Device.PlcLogic.Application.MyObject”. InOut: Scope Name Type Comment Return UserMgrObjectAdd RTS_IEC_HANDLE Handle to the object or RTS_INVALID_HANDLE if it could not be added Input pszObject REFERENCE TO STRING Full object name (see object tree) pResult POINTER TO RTS_IEC_RESULT Pointer to error code ERR_OK: Object could be added ERR_PARAMETER: Object invalid = NULL or empty ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_NOMEMORY: If memory could not be allocated to store this object ERR_NO_ACCESS_RIGHTS: No access rights in IEC context

UserMgrObjectAddGroup (FUN) ¶ FUNCTION UserMgrObjectAddGroup : RTS_IEC_RESULT Add a group to the specified object to manage access rights InOut: Scope Name Type Comment Return UserMgrObjectAddGroup RTS_IEC_RESULT Error code ERR_OK: Group could be added or is already added ERR_PARAMETER: Invalid handles ERR_NOMEMORY: No memory to add group 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 attached

UserMgrObjectClearRights (FUN) ¶ FUNCTION UserMgrObjectClearRights : RTS_IEC_RESULT This function clears all granted and denied rights for all groups on that object. InOut: Scope Name Type Comment Return UserMgrObjectClearRights RTS_IEC_RESULT Error code ERR_OK: Access rights could be cleared 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

UserMgrObjectGetFirstChild (FUN) ¶ FUNCTION UserMgrObjectGetFirstChild : RTS_IEC_HANDLE Iteration interface to get the first child object in the object tree of the specified father object Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectGetFirstChild RTS_IEC_HANDLE Handle to the child object or RTS_INVALID_HANDLE if failed Input hFatherObject RTS_IEC_HANDLE Handle to the father object Output Result RTS_IEC_RESULT Error code ERR_OK: First child object available ERR_PARAMETER: Invalid parameter hFatherObject ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_NO_ACCESS_RIGHTS: No access rights in IEC context