summaryrefslogtreecommitdiffstats
path: root/doc/registry.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2002-10-18 23:58:18 (GMT)
committerhobbs <hobbs>2002-10-18 23:58:18 (GMT)
commitb5af65e9d69a52d972ebbcb19fcd5bebd1bdc884 (patch)
treef578423d541f524d5318a0b5e268890697eebffb /doc/registry.n
parent7913e154bd7705f376f1d3991b4050b4ab69b442 (diff)
downloadtcl-b5af65e9d69a52d972ebbcb19fcd5bebd1bdc884.zip
tcl-b5af65e9d69a52d972ebbcb19fcd5bebd1bdc884.tar.gz
tcl-b5af65e9d69a52d972ebbcb19fcd5bebd1bdc884.tar.bz2
* doc/registry.n: Added support for broadcasting changes to
* tests/registry.test: the registry Environment. Noted proper code * win/tclWinReg.c: in the docs. [Patch #625453]
Diffstat (limited to 'doc/registry.n')
-rw-r--r--doc/registry.n20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/registry.n b/doc/registry.n
index 7f36a20..5264ad4 100644
--- a/doc/registry.n
+++ b/doc/registry.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: registry.n,v 1.6 2002/07/01 18:24:39 jenglish Exp $
+'\" RCS: @(#) $Id: registry.n,v 1.7 2002/10/18 23:58:18 hobbs Exp $
'\"
.so man.macros
.TH registry n 1.0 registry "Tcl Bundled Packages"
@@ -50,6 +50,24 @@ registry key names separated by backslash (\fB\e\fR) characters.
unique abbreviation for \fIoption\fR is acceptable. The valid options
are:
.TP
+.VS 8.4
+\fBregistry broadcast \fIkeyName\fR ?\fI-timeout milliseconds\fR?
+.
+Sends a broadcast message to the system and running programs to notify them
+of certain updates. This is necessary to propagate changes to key registry
+keys like Environment. The timeout specifies the amount of time, in
+milliseconds, to wait for applications to respond to the broadcast message.
+It defaults to 3000. The following example demonstrates how to add a path
+to the global Environment and notify applications of the change without
+reguiring a logoff/logon step (assumes admin privileges):
+.CS
+set regPath {HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\Session Manager\\Environment}
+set curPath [registry get $regPath "Path"]
+registry set $regPath "Path" "$curPath;$addPath"
+registry broadcast "Environment"
+.CE
+.VE 8.4
+.TP
\fBregistry delete \fIkeyName\fR ?\fIvalueName\fR?
.
If the optional \fIvalueName\fR argument is present, the specified