ExaminePreferenceKeys()

Syntax

Result = ExaminePreferenceKeys()
Description
Starts the enumeration of all the keys found in the current group of the preference file. The current group can be selected with PreferenceGroup() or by examining all groups with ExaminePreferenceGroups(). NextPreferenceKey() can be used to list all the keys 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")
  
  ; Select a group
  PreferenceGroup("Window")
  
  ; Examine keys in the group 'Window'
  ExaminePreferenceKeys()
  While  NextPreferenceKey() ; While a key exists
    MessageRequester("Key group 'Window'", PreferenceKeyName() + " = " + PreferenceKeyValue())  ; Display the key with its data
  Wend
  
  ; Close the preference file
  ClosePreferences()  

See Also

ExaminePreferenceGroups(), NextPreferenceGroup(), NextPreferenceKey()

Supported OS

All

<- ExaminePreferenceGroups() - Preference Index - FlushPreferenceBuffers() ->