diff options
Diffstat (limited to 'doc/PkgRequire.3')
| -rw-r--r-- | doc/PkgRequire.3 | 26 |
1 files changed, 11 insertions, 15 deletions
diff --git a/doc/PkgRequire.3 b/doc/PkgRequire.3 index bdf6103..b7d0e6e 100644 --- a/doc/PkgRequire.3 +++ b/doc/PkgRequire.3 @@ -3,7 +3,7 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" +'\" .TH Tcl_PkgRequire 3 7.5 Tcl "Tcl Library Procedures" .so man.macros .BS @@ -34,31 +34,32 @@ int int \fBTcl_PkgProvideEx\fR(\fIinterp, name, version, clientData\fR) .SH ARGUMENTS -.AS void *clientDataPtr out +.AS ClientData clientDataPtr out .AP Tcl_Interp *interp in Interpreter where package is needed or available. .AP "const char" *name in Name of package. .AP "const char" *version in -A version specification string as described for \fBpackage require\fR. +A version string consisting of one or more decimal numbers +separated by dots. .AP int exact in Non-zero means that only the particular version specified by \fIversion\fR is acceptable. Zero means that newer versions than \fIversion\fR are also acceptable as long as they have the same major version number as \fIversion\fR. -.AP "const void" *clientData in +.AP ClientData clientData in Arbitrary value to be associated with the package. -.AP void *clientDataPtr out +.AP ClientData *clientDataPtr out Pointer to place to store the value associated with the matching package. It is only changed if the pointer is not NULL and the -function completed successfully. The storage can be any pointer -type with the same size as a void pointer. +function completed successfully. .AP int objc in Number of requirements. .AP Tcl_Obj* objv[] in Array of requirements. .BE + .SH DESCRIPTION .PP These procedures provide C-level interfaces to Tcl's package and @@ -74,8 +75,8 @@ procedures do. .PP If \fBTcl_PkgPresent\fR or \fBTcl_PkgRequire\fR complete successfully they return a pointer to the version string for the version of the package -that is provided in the interpreter (which may be different than -\fIversion\fR); if an error occurs they return NULL and leave an error +that is provided in the interpreter (which may be different than +\fIversion\fR); if an error occurs they return NULL and leave an error message in the interpreter's result. .PP \fBTcl_PkgProvide\fR returns \fBTCL_OK\fR if it completes successfully; @@ -90,11 +91,6 @@ functions. \fBTcl_PkgRequireProc\fR is the form of \fBpackage require\fR handling multiple requirements. The other forms are present for backward compatibility and translate their invocations to this form. -.SH "REFERENCE COUNT MANAGEMENT" -.PP -The requirements values given (in the \fIobjv\fR argument) to -\fBTcl_PkgRequireProc\fR must have non-zero reference counts. + .SH KEYWORDS package, present, provide, require, version -.SH "SEE ALSO" -package(n), Tcl_StaticLibrary(3) |