UserSecurityServicesGetRole Method

Retrieves a single security role definition.

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 Role GetRole(
	Guid sessionId,
	string roleName
)

Public Function GetRole ( 
	sessionId As Guid,
	roleName As String
) As Role

public:
virtual Role^ GetRole(
	Guid sessionId, 
	String^ roleName
) sealed

abstract GetRole : 
        sessionId : Guid * 
        roleName : string -> Role 
override GetRole : 
        sessionId : Guid * 
        roleName : string -> Role

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 security role to be retrieved.

Return Value

Type: Role
A Role object representing the security role specified by the roleName parameter

Exceptions

Exception	Condition
InvalidSessionException	Thrown if the sessionId parameter is invalid.
ArgumentException	Occurs if any of the parameters are invalid.
RoleNotFoundException	Thrown if the role specified by the roleName parameter does not exist.

Reference

UserSecurityServices Class

FactoryLogix.xTend.Configuration Namespace

UserSecurityServicesAddLanguageSpecificTextSet("LST11BA6DD1_0?cpp=::|nu=.");GetRole Method

Parameters

Return Value

Reference

UserSecurityServicesGetRole Method