PreferenceComment()

Syntax

PreferenceComment(Text$)
Description
Writes a new comment line in the current preference file.

Parameters

Text$ The new comment to write.

Return value

None.

Example

  ; Création du fichier prefs.txt
  If CreatePreferences(GetTemporaryDirectory()+"Prefs.txt")

    PreferenceComment("The coordinates of the window.") ; Write a comment
    PreferenceComment("") ; Write a comment (empty line)

    PreferenceGroup("Window")
      WritePreferenceLong ("X", 100)
      WritePreferenceLong ("Y", 125)

      ClosePreferences()
    
      RunProgram(GetTemporaryDirectory()+"Prefs.txt")
  EndIf

Supported OS

All

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