Edit

Share via

SessionSettings.LocaleId([Integer]) Method

  • Article

Version: Available or changed with runtime version 1.0.

Gets or sets the locale ID property in a SessionSettings object.

Syntax

[LocaleId := ]  SessionSettings.LocaleId([NewLocaleId: Integer])

Note

This method can be invoked using property access syntax.

Parameters

SessionSettings
 Type: SessionSettings
An instance of the SessionSettings data type.

[Optional] NewLocaleId
 Type: Integer
Specifies the locale ID to set in the SessionSettings object. The value must be a valid Windows locale ID.

Return Value

[Optional] LocaleId
 Type: Integer
The locale ID that is set in the SessionSettings object.

Remarks

The locale ID in the SessionSettings object corresponds to the Locale ID field in the system table 2000000073 User Personalization for the client session user.

Example

This example creates a SessionSettings object that is populated with the current client user's personalization data, and then uses the LocaleId method to set the locale ID to '1033'. Finally, the RequestSessionUpdate method sends a request to the client to abandon the current client session and start a new session that uses the new locale ID. This example requires a SessionSettings data type variable.

var
  MySessionSettings : SessionSettings;
begin
  MySessionSettings.Init;
  MySessionSettings.LocaleId(1033);
  MySessionSettings.RequestSessionUpdate(false);
end;

SessionSettings Data Type
Get Started with AL
Developing Extensions