| 1 | '\" |
|---|
| 2 | '\" Copyright (c) 1999 Scriptics Corporation |
|---|
| 3 | '\" |
|---|
| 4 | '\" See the file "license.terms" for information on usage and redistribution |
|---|
| 5 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
|---|
| 6 | '\" |
|---|
| 7 | '\" RCS: @(#) $Id: GetVersion.3,v 1.4 2004/10/07 14:44:32 dkf Exp $ |
|---|
| 8 | '\" |
|---|
| 9 | .so man.macros |
|---|
| 10 | .TH Tcl_GetVersion 3 7.5 Tcl "Tcl Library Procedures" |
|---|
| 11 | .BS |
|---|
| 12 | .SH NAME |
|---|
| 13 | Tcl_GetVersion \- get the version of the library at runtime |
|---|
| 14 | .SH SYNOPSIS |
|---|
| 15 | .nf |
|---|
| 16 | \fB#include <tcl.h>\fR |
|---|
| 17 | .sp |
|---|
| 18 | \fBTcl_GetVersion\fR(\fImajor, minor, patchLevel, type\fR) |
|---|
| 19 | .SH ARGUMENTS |
|---|
| 20 | .AS Tcl_ReleaseType *patchLevel out |
|---|
| 21 | .AP int *major out |
|---|
| 22 | Major version number of the Tcl library. |
|---|
| 23 | .AP int *minor out |
|---|
| 24 | Minor version number of the Tcl library. |
|---|
| 25 | .AP int *patchLevel out |
|---|
| 26 | The patch level of the Tcl library (or alpha or beta number). |
|---|
| 27 | .AP Tcl_ReleaseType *type out |
|---|
| 28 | The type of release, also indicates the type of patch level. Can be |
|---|
| 29 | one of \fBTCL_ALPHA_RELEASE\fR, \fBTCL_BETA_RELEASE\fR, or |
|---|
| 30 | \fBTCL_FINAL_RELEASE\fR. |
|---|
| 31 | .BE |
|---|
| 32 | |
|---|
| 33 | .SH DESCRIPTION |
|---|
| 34 | .PP |
|---|
| 35 | \fBTcl_GetVersion\fR should be used to query the version number |
|---|
| 36 | of the Tcl library at runtime. This is useful when using a |
|---|
| 37 | dynamically loaded Tcl library or when writing a stubs-aware |
|---|
| 38 | extension. For instance, if you write an extension that is |
|---|
| 39 | linked against the Tcl stubs library, it could be loaded into |
|---|
| 40 | a program linked to an older version of Tcl than you expected. |
|---|
| 41 | Use \fBTcl_GetVersion\fR to verify that fact, and possibly to |
|---|
| 42 | change the behavior of your extension. |
|---|
| 43 | .PP |
|---|
| 44 | \fBTcl_GetVersion\fR accepts NULL for any of the arguments. For instance if |
|---|
| 45 | you do not care about the \fIpatchLevel\fR of the library, pass |
|---|
| 46 | a NULL for the \fIpatchLevel\fR argument. |
|---|
| 47 | |
|---|
| 48 | .SH KEYWORDS |
|---|
| 49 | version, patchlevel, major, minor, alpha, beta, release |
|---|
| 50 | |
|---|
