Permanently deletes a seurity role from the system. All users, user groups, and permissions associated to this role will be disassociated from the role, but not be deleted.

Namespace: FactoryLogix.xTend.Configuration
Assembly: FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.242.0.0 (8.242.0.0)

Syntax

C++

Copy

public void DeleteRole(
	Guid sessionId,
	string roleName
)

Public Sub DeleteRole ( 
	sessionId As Guid,
	roleName As String
)

public:
virtual void DeleteRole(
	Guid sessionId, 
	String^ roleName
) sealed

abstract DeleteRole : 
        sessionId : Guid * 
        roleName : string -> unit 
override DeleteRole : 
        sessionId : Guid * 
        roleName : string -> unit

Parameters

sessionId: Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method.
roleName: Type: SystemString
The friendly name of the role to be deleted.

Exceptions

Exception	Condition
InvalidSessionException	Thrown if the sessionId parameter is invalid.
NotAuthorizedException	Occurs if the current user is not authorized to use this feature.
ArgumentException	Occurs if any of the parameters are invalid.
RoleNotFoundException	Thrown if role specified by the roleName parameter does not exist.
NotAuthorizedException	Thrown when not authorized to perform the function.

Reference

UserSecurityServices Class

FactoryLogix.xTend.Configuration Namespace

UserSecurityServicesAddLanguageSpecificTextSet("LSTDFE16756_0?cpp=::|nu=.");DeleteRole Method

Parameters

Reference

UserSecurityServicesDeleteRole Method