PreferenceKeyValue()

Syntax

Value$ = PreferenceKeyValue()

Returns the value, in string form, of the current key being enumerated with ExaminePreferenceKeys(). To get the name of the key, use PreferenceKeyName().

Parameters

None.

Return value

The value, in string form, of the current key being enumerated with ExaminePreferenceKeys().

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()  

For another example (the keys are the data themselves), see WritePreferenceString().

See Also

ExaminePreferenceKeys(), PreferenceKeyName()

Supported OS

All