Preferences Component

Fnd_Pref_GetBoolean

Fnd_Pref_GetBoolean (name{; default {; scope}}) -> Boolean

Legacy manual page 175

Parameters

ParameterTypeDescription
nameTextName of the preference item
defaultBooleanDefault value (optional)
scopeLongintThe scope if the default is used (optional)
Function resultBooleanThe saved value

Description

Returns the Boolean value of the preference with the specified name:

$displayToolbar_b:=Fnd_Pref_GetBoolean ("Toolbar")

If an item with the specified name is not found, False is returned. To specify a different default value, pass it as the second parameter:

$displayToolbar_b:=Fnd_Pref_GetBoolean ("Toolbar";True)

If the preference value already exists, the second parameter will be ignored. If it does not exist, it will be created and set to the value of the second parameter. If no scope parameter is specified, the value will be saved as a local preference. A third parameter can be used to specify the preference’s scope:

$displayToolbar_b:=Fnd_Pref_GetBoolean ("Toolbar";True;Fnd_Pref_Server )

The scope value will be used only if the parameter does not already exist.

Extracted source text
       Fnd_Pref_GetBoolean (name{; default {; scope}}) ➔ Boolean

          Parameter                Type               Description
          name                     Text               Name of the preference item
          default                  Boolean            Default value (optional)
          scope                    Longint            The scope if the default is used (optional)
          Function result          Boolean            The saved value

       Returns the Boolean value of the preference with the specified name:
          $displayToolbar_b:=Fnd_Pref_GetBoolean ("Toolbar")

       If an item with the specified name is not found, False is returned. To specify a different default value,
       pass it as the second parameter:
          $displayToolbar_b:=Fnd_Pref_GetBoolean ("Toolbar";True)

        If the preference value already exists, the second parameter will be ignored. If it does not exist, it will be
       created and set to the value of the second parameter.
       If no scope parameter is specified, the value will be saved as a local preference. A third parameter can be
       used to specify the preference’s scope:
          $displayToolbar_b:=Fnd_Pref_GetBoolean ("Toolbar";True;Fnd_Pref_Server )

       The scope value will be used only if the parameter does not already exist.