summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorkh <karsten.heimrich@theqtcompany.com>2015-04-14 14:27:22 +0200
committerKarsten Heimrich <karsten.heimrich@theqtcompany.com>2015-04-14 12:28:33 +0000
commit4fff02a58beeb7e7890e8560f44cc6c7f7ce2a9b (patch)
treea903a07f53877170e44ce676727776b2c0012ede /doc
parent31b0637b4a1ce19c0d7698626493c199bb007adb (diff)
Document the operation storing mechanism more precisely.
Task-number: QTIFW-669 Change-Id: I7b4a89f74c0e82ec091876effaedf304de345fbd Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/operations.qdoc9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/operations.qdoc b/doc/operations.qdoc
index ef0a5ff32..f2b8c5531 100644
--- a/doc/operations.qdoc
+++ b/doc/operations.qdoc
@@ -172,6 +172,15 @@
(using \c QSettings::NativeFormat, which might be the Windows
registry) or by \c application and \c company name. Set \c scope
to "SystemScope" to create an entry in the system scope.
+
+ \note: The operation is using QSettings to store the key value pair. QSettings
+ always treats backslash as a special character and provides no API for reading
+ or writing such entries. Do not use slashes ('/' and '\') in section or key names;
+ the backslash character is used to separate sub keys. On windows, '\' are converted
+ by QSettings to '/', which makes them identical. Because the backslash character is
+ used by QSettings to separate sub keys, you cannot read or write windows registry
+ entries that contain slashes or backslashes. You should use a native windows API if
+ you need to do so.
\row
\li EnvironmentVariable
\li "EnvironmentVariable" \c key \c value [\c persistent [\c system]]