summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2024-04-17 09:18:26 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2024-04-17 09:18:26 (GMT)
commit48f6d9f5e024f50dc3b87dfa5e4785901e0f5142 (patch)
tree04942080cd8d03145ebe2b1eb4d213d1d4ec7e3f /doc
parentbfe130956f0d198332bdcfaa5be110b24fc0237c (diff)
downloadtcl-48f6d9f5e024f50dc3b87dfa5e4785901e0f5142.zip
tcl-48f6d9f5e024f50dc3b87dfa5e4785901e0f5142.tar.gz
tcl-48f6d9f5e024f50dc3b87dfa5e4785901e0f5142.tar.bz2
Deprecate Tcl_GetAlias(). Will be removed in Tcl 9.0b3
Diffstat (limited to 'doc')
-rw-r--r--doc/CrtAlias.39
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/CrtAlias.3 b/doc/CrtAlias.3
index a642d08..7d75fc6 100644
--- a/doc/CrtAlias.3
+++ b/doc/CrtAlias.3
@@ -209,16 +209,17 @@ restrictions on how they are related.
that it takes a vector of values to pass as additional arguments instead
of a vector of strings.
.PP
-\fBTcl_GetAlias\fR returns information about an alias \fIaliasName\fR
+\fBTcl_GetAliasObj\fR returns information in the form of a pointer to
+a vector of Tcl_Obj structures about an alias \fIaliasName\fR
in \fIinterp\fR. Any of the result fields can be \fBNULL\fR, in
which case the corresponding datum is not returned. If a result field is
non\-\fBNULL\fR, the address indicated is set to the corresponding datum.
For example, if \fItargetNamePtr\fR is non\-\fBNULL\fR it is set to a
pointer to the string containing the name of the target command.
.PP
-\fBTcl_GetAliasObj\fR is similar to \fBTcl_GetAlias\fR except that it
-returns a pointer to a vector of Tcl_Obj structures instead of a vector of
-strings.
+\fBTcl_GetAlias\fR is similar to \fBTcl_GetAliasObj\fR except that it
+returns a pointer to a vector of string instead of a vector of
+Tcl_Obj structures. \fBTcl_GetAlias\fR is deprecated.
.PP
\fBTcl_ExposeCommand\fR moves the command named \fIhiddenCmdName\fR from
the set of hidden commands to the set of exposed commands, putting