PreferenceGroupName()

Syntax

Group$ = PreferenceGroupName()
Description
Returns the name of the current group being enumerated with ExaminePreferenceGroups() or previously selected with PreferenceGroup().

Parameters

None.

Return value

The name of the current group being enumerated with ExaminePreferenceGroups() or previously selected with PreferenceGroup().

Example

  ; Open a preference file
  OpenPreferences(#PB_Compiler_Home +"Examples\Sources\Data\test.pref")
  
  ; Examine groups
  ExaminePreferenceGroups()
  While NextPreferenceGroup() ; While group exists
    MessageRequester("Groups", PreferenceGroupName())  ; Display this group
  Wend
  
  ; Close the preference file
  ClosePreferences() 

See Also

ExaminePreferenceGroups()

Supported OS

All

<- PreferenceGroup() - Preference Index - PreferenceKeyName() ->