SystemSettingServicesGetPersonalSetting Method

Returns the personalized value of a system setting for a particular user account.

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 Object GetPersonalSetting(
	Guid sessionId,
	SystemSettings setting,
	string userName
)

Public Function GetPersonalSetting ( 
	sessionId As Guid,
	setting As SystemSettings,
	userName As String
) As Object

public:
virtual Object^ GetPersonalSetting(
	Guid sessionId, 
	SystemSettings setting, 
	String^ userName
) sealed

abstract GetPersonalSetting : 
        sessionId : Guid * 
        setting : SystemSettings * 
        userName : string -> Object 
override GetPersonalSetting : 
        sessionId : Guid * 
        setting : SystemSettings * 
        userName : string -> Object

Parameters

sessionId: Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method.
setting: Type: FactoryLogix.xTend.DataObjectsSystemSettings
An enumerated value specifying the system setting value being requested.
userName: Type: SystemString
The username of the user account whose personalized system setting is being requested.

Return Value

Type: Object
The system setting value, the type of which will vary based upon the specific setting that was requested (bool, int, string, etc.).

Exceptions

Exception	Condition
InvalidSessionException	Thrown if the sessionId parameter is invalid.
UserNotFoundException	Thrown if the userName parameter does not designate a valid FactoryLogix user account.
ArgumentException	Occurs if any of the parameters are invalid.

Reference

SystemSettingServices Class

FactoryLogix.xTend.Configuration Namespace

SystemSettingServicesAddLanguageSpecificTextSet("LSTDC004515_0?cpp=::|nu=.");GetPersonalSetting Method

Parameters

Return Value

Reference

SystemSettingServicesGetPersonalSetting Method