UCR.GetRoleByName
Optional integration
This method requires UncomplicatedCustomRoles.
Gets a registered UCR role by name.
Syntax
UCR.GetRoleByName "role_name"
Returns
reference to UCRRole object
Arguments
| Name | Required | Type | Description |
|---|---|---|---|
role name | Yes | Any text e.g. "Hello, World!" |
Details
Role names are matched without case sensitivity.
Possible errors
- The role name is not registered in UCR.
On a running server
Use serhelp UCR.GetRoleByName to inspect the reference generated by your installed SER version.