Tcl_PkgRequire (3)
package version control
SYNOPSIS
#include <tcl.h>
char *
Tcl_PkgRequire(interp, name, version, exact)
int
Tcl_PkgProvide(interp, name, version)
ARGUMENTS
Tcl_FreeProc clientData
Tcl_Interp *interp in
Interpreter where package is needed or available.
char *name in
Name of package.
char *version in
A version string consisting of one or more decimal numbers
separated by dots.
int exact in
Non-zero means that only the particular version specified by
version is acceptable.
Zero means that newer versions than version are also
acceptable as long as they have the same major version number
as version.
DESCRIPTION
These procedures provide C-level interfaces to Tcl's package and
version management facilities.
Tcl_PkgRequire is equivalent to the package require
command, and Tcl_PkgProvide is equivalent to the
package provide command.
See the documentation for the Tcl commands for details on what these
procedures do.
If Tcl_PkgRequire completes successfully it returns a pointer
to the version string for the version of the package that is provided
in the interpreter (which may be different than version); if
an error occurs it returns NULL and leaves an error message in
interp->result.
Tcl_PkgProvide returns TCL_OK if it completes successfully;
if an error occurs it returns TCL_ERROR and leaves an error message
in interp->result.
KEYWORDS
package, provide, require, version
'\"
'\" Copyright (c) 1989-1993 The Regents of the University of California.
'\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: AddErrInfo.3,v 1.2 1998/09/14 18:39:45 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
