SystemSettingServicesGetSystemSetting Method

Returns the current value of the specified system setting.

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

Syntax

C++

Copy

public Object GetSystemSetting(
	Guid sessionId,
	SystemSettings setting
)

Public Function GetSystemSetting ( 
	sessionId As Guid,
	setting As SystemSettings
) As Object

public:
virtual Object^ GetSystemSetting(
	Guid sessionId, 
	SystemSettings setting
) sealed

abstract GetSystemSetting : 
        sessionId : Guid * 
        setting : SystemSettings -> Object 
override GetSystemSetting : 
        sessionId : Guid * 
        setting : SystemSettings -> 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.

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.
ArgumentException	Occurs if any of the parameters are invalid.

Reference

SystemSettingServices Class

FactoryLogix.xTend.Configuration Namespace

SystemSettingServicesAddLanguageSpecificTextSet("LSTDFE5C84_0?cpp=::|nu=.");GetSystemSetting Method

Parameters

Return Value

Reference

SystemSettingServicesGetSystemSetting Method