Retrieves the details of a particular FactoryLogix user group. User groups are collections of individual users who share certain rights, roles, or group email addresses.

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 UserGroup GetUserGroup(
	Guid sessionId,
	string userGroupName
)

Public Function GetUserGroup ( 
	sessionId As Guid,
	userGroupName As String
) As UserGroup

public:
virtual UserGroup^ GetUserGroup(
	Guid sessionId, 
	String^ userGroupName
) sealed

abstract GetUserGroup : 
        sessionId : Guid * 
        userGroupName : string -> UserGroup 
override GetUserGroup : 
        sessionId : Guid * 
        userGroupName : string -> UserGroup

Parameters

sessionId: Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method.
userGroupName: Type: SystemString
The friendly name of the user group to be retrieved.

Return Value

Type: UserGroup
A list of UserGroup objects representing the details of the FactoryLogix user groups.

Exceptions

Exception	Condition
InvalidSessionException	Thrown if the sessionId parameter is invalid.
ArgumentException	Occurs if any of the parameters are invalid.
UserGroupNotFoundException	Thrown if the username parameter is invalid.

Reference

UserSecurityServices Class

FactoryLogix.xTend.Configuration Namespace

UserSecurityServicesAddLanguageSpecificTextSet("LSTB58443F3_0?cpp=::|nu=.");GetUserGroup Method

Parameters

Return Value

Reference

UserSecurityServicesGetUserGroup Method