ExaminePreferenceGroups()

Syntax

Result = ExaminePreferenceGroups()

Starts the enumeration of all the groups found in the current preference file. NextPreferenceGroup() can be used to list all the group found.

Parameters

None.

Return value

Nonzero if the enumeration has been successfully started, zero otherwise.

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

NextPreferenceGroup()

Supported OS

All