SessionSettings.ProfileSystemScope([Boolean]) Method

Article
02/26/2024

Version: Available or changed with runtime version 1.0.

Gets or sets the profile scope property in a SessionSettings object.

Syntax

[ProfileSystemScope := ]  SessionSettings.ProfileSystemScope([NewProfileScope: Boolean])

Note

This method can be invoked using property access syntax.

Parameters

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

[Optional] NewProfileScope
Type: Boolean
Specifies whether the profile applies to the system or to a tenant only. true sets the profile to apply to the system; false sets the profile to apply to a tenant only.

Return Value

[Optional] ProfileSystemScope
Type: Boolean
true if the profile applies to the system; false if the profile applies to a tenant.

Remarks

The ProfileSystemScope property in a SessionSettings object corresponds to the Scope field in the in the system table 2000000073 User Personalization.

Example

This example creates a SessionSettings object, and then uses the ProfileSystemScope method to set the profile scope to apply to the system. This example requires a SessionSettings data type variable.

var
  MySessionSettings : SessionSettings;
begin
  MySessionSettings.ProfileSystemScope(true);
end;