SessionSettings.LanguageId([Integer]) Method

Article
02/26/2024

Version: Available or changed with runtime version 1.0.

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

Syntax

[LanguageId := ]  SessionSettings.LanguageId([NewLanguageId: Integer])

Note

This method can be invoked using property access syntax.

Parameters

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

[Optional] NewLanguageId
Type: Integer
Specifies the language ID to set in the SessionSettings object. The value must be a valid Windows language ID, which is typically a 4-digit value such as 1033 for English or 1030 for Danish. The default value is 1033.

Return Value

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

Remarks

The langauge ID in the SessionSettings object corresponds to the Language ID field in the system table 2000000073 User Personalization.

Example

This example creates a SessionSettings object that is populated with the current client user's personalization data, and then uses the LanguageId method to change the language ID to '1030'. 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 language. This example requires a SessionSettings data type variable.

var
  MySessionSettings : SessionSettings;
begin
  MySessionSettings.Init;
  MySessionSettings.LanguageId(1030);
  MySessionSettings.RequestSessionUpdate(false);
end;