AddRight Method (UserRights)

In This Topic

Adds the specified right entry to the given category of the custom UserRights file. The new right name will appear in the rights management dialog.

Syntax

C#
C++/CLI

public bool AddRight( 
   string strRightname,
   string strCategory
)

public:
bool AddRight( 
   String^ strRightname,
   String^ strCategory
)

Parameters

Parameter Name	Description
strRightname	Right name as a string
strCategory	Category name as a string. Only existing categories can be used. You can get the existing categories by the `GetCategories` method. You need to set the complete category name that you can find in the `StringCollection` returned by `GetCategory`.

Return Value

• TRUE: The new right was successfully added to the rights management database. • FALSE: The new right could not be added to the rights management database.

Exceptions

Exception	Description
System.ApplicationException	Thrown when the logged-in user doesn't have the necessary right to work on the user rights.
System.ArgumentException	Thrown when the given right `strRightname` already exist.
System.ArgumentException	Thrown when the category `strCategory` does not exist.

Remarks

The currently logged-in user must have the URShowAdministrationDialog right, this is the right to work on user rights.
The custom user rights will be saved to the "$(EPLAN_DATA)\\Administration\\customrights.erm" file. The system administrator needs to protect this file from changes by unauthorized persons.

Reference

UserRights Class
UserRights Members

Use the Eplan Global Support Portal for feedback and support