GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  TCL_PKGPRESENT (3)

NAME

Tcl_PkgRequire, Tcl_PkgRequireEx, Tcl_PkgRequireProc, Tcl_PkgPresent, Tcl_PkgPresentEx, Tcl_PkgProvide, Tcl_PkgProvideEx - package version control

CONTENTS

Synopsis
Arguments
Description
Keywords

SYNOPSIS

#include <tcl.h>

const char * Tcl_PkgRequire(interp, name, version, exact)

const char * Tcl_PkgRequireEx(interp, name, version, exact, clientDataPtr)

int Tcl_PkgRequireProc(interp, name, objc, objv, clientDataPtr)

const char * Tcl_PkgPresent(interp, name, version, exact)

const char * Tcl_PkgPresentEx(interp, name, version, exact, clientDataPtr)

int Tcl_PkgProvide(interp, name, version)

int Tcl_PkgProvideEx(interp, name, version, clientData)

ARGUMENTS


.TP 15 Tcl_Interp *interp (in)
Tcl_Interp*interp Tcl_Interp Interpreter where package is needed or available.
.TP 15 const char *name (in)
const char*name const char Name of package.
.TP 15 const char *version (in)
const char*version const char A version string consisting of one or more decimal numbers separated by dots.
.TP 15 int exact (in)
int       exact int 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.
.TP 15 ClientData clientData (in)
ClientDataclientData ClientData Arbitrary value to be associated with the package.
.TP 15 ClientData *clientDataPtr (out)
ClientData*clientDataPtr ClientData 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.
.TP 15 int objc (in)
int       objc int Number of requirements.
.TP 15 Tcl_Obj* objv[] (in)
Tcl_Obj*  objv[] Tcl_Obj* Array of requirements.

   








\L’|0u-1v’\l’75u+3n_’\L’0u+1v-0u’\l’|0u-1.5n_’



\L’|0u-1v’\L’0u+1v-0u’\l’|0u-1.5n_’





DESCRIPTION

These procedures provide C-level interfaces to Tcl’s package and version management facilities.

Tcl_PkgRequire is equivalent to the package require command, Tcl_PkgPresent is equivalent to the package present 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_PkgPresent or Tcl_PkgRequire 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 version); if an error occurs they return NULL and leave an error message in the interpreter’s result.

Tcl_PkgProvide returns TCL_OK if it completes successfully; if an error occurs it returns TCL_ERROR and leaves an error message in the interpreter’s result.

Tcl_PkgProvideEx, Tcl_PkgPresentEx and Tcl_PkgRequireEx allow the setting and retrieving of the client data associated with the package. In all other respects they are equivalent to the matching functions.

Tcl_PkgRequireProc is the form of package require handling multiple requirements. The other forms are present for backward compatibility and translate their invokations to this form.

KEYWORDS

package, present, provide, require, version
Search for    or go to Top of page |  Section 3 |  Main Index


Tcl TCL_PKGREQUIRE (3) 7.5

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.