summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorredman <redman>1999-03-11 19:29:34 (GMT)
committerredman <redman>1999-03-11 19:29:34 (GMT)
commit2efa9d528732f61a4c62d4919c68aa372a3c4f6f (patch)
tree178827b4bf56e67b2966de4d8686a26e88072b72 /doc
parent0c1e2fd32193b13a516b2efbc1c5949057aacb5c (diff)
downloadtcl-2efa9d528732f61a4c62d4919c68aa372a3c4f6f.zip
tcl-2efa9d528732f61a4c62d4919c68aa372a3c4f6f.tar.gz
tcl-2efa9d528732f61a4c62d4919c68aa372a3c4f6f.tar.bz2
Add documentation for Tcl_GetVersion()
Diffstat (limited to 'doc')
-rw-r--r--doc/CrtVersion.349
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/CrtVersion.3 b/doc/CrtVersion.3
new file mode 100644
index 0000000..4333786
--- /dev/null
+++ b/doc/CrtVersion.3
@@ -0,0 +1,49 @@
+'\"
+'\" Copyright (c) 1999 Scriptics Corporation
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: CrtVersion.3,v 1.2 1999/03/11 19:29:34 redman Exp $
+'\"
+.so man.macros
+.TH Tcl_GetVersion 3 7.5 Tcl "Tcl Library Procedures"
+.BS
+.SH NAME
+Tcl_GetVersion \- get the version of the library at runtime
+.SH SYNOPSIS
+.nf
+\fB#include <tcl.h>\fR
+.sp
+\fBTcl_GetVersion\fR(\fmajor, minor, patchLevel, type\fR)
+.SH ARGUMENTS
+.AP int *major out
+Major version number of the Tcl library.
+.AP int *minor out
+Minor version number of the Tcl library.
+.AP int *patchLevel out
+The patch level of the Tcl library (or alpha or beta number).
+.AP Tcl_ReleaseType *type out
+The type of release, also indicates the type of patch level. Can be
+one of \fBTCL_ALPHA_RELEASE\fR, \fBTCL_BETA_RELEASE\fR, or
+\fBTCL_FINAL_RELEASE\fR.
+.BE
+
+.SH DESCRIPTION
+.PP
+\fBTcl_GetVersion\fR should be used to query the version number
+of the Tcl library at runtime. This is useful when using a
+dynamically loaded Tcl library or when writing a stubs-aware
+extension. For instance, if you write an extension that is
+linked against the Tcl stubs library, it could be loaded into
+a program linked to an older version of Tcl than you expected.
+Use \fBTcl_GetVersion\fR to verify that fact, and possibly to
+change the behavior of your extension.
+.PP
+If may pass a NULL for any of the arguments. For instance if
+you do not care about the \fIpatchLevel\fI of the library, pass
+a NULL for the \fIpatchLevel\fI argument.
+
+.SH KEYWORDS
+version, patchlevel, major, minor, alpha, beta, release
+