PkgRequire.3
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:3k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1996 Sun Microsystems, Inc.
  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: PkgRequire.3,v 1.6.2.1 2006/09/22 01:26:22 andreas_kupries Exp $
  8. '" 
  9. .so man.macros
  10. .TH Tcl_PkgRequire 3 7.5 Tcl "Tcl Library Procedures"
  11. .BS
  12. .SH NAME
  13. Tcl_PkgRequire, Tcl_PkgRequireEx, Tcl_PkgPresent, Tcl_PkgPresentEx, Tcl_PkgProvide, Tcl_PkgProvideEx - package version control
  14. .SH SYNOPSIS
  15. .nf
  16. fB#include <tcl.h>fR
  17. .sp
  18. CONST char *
  19. fBTcl_PkgRequirefR(fIinterp, name, version, exactfR)
  20. .sp
  21. CONST char *
  22. fBTcl_PkgRequireExfR(fIinterp, name, version, exact, clientDataPtrfR)
  23. .sp
  24. CONST char *
  25. fBTcl_PkgPresentfR(fIinterp, name, version, exactfR)
  26. .sp
  27. CONST char *
  28. fBTcl_PkgPresentExfR(fIinterp, name, version, exact, clientDataPtrfR)
  29. .sp
  30. int
  31. fBTcl_PkgProvidefR(fIinterp, name, versionfR)
  32. .sp
  33. int
  34. fBTcl_PkgProvideExfR(fIinterp, name, version, clientDatafR)
  35. .SH ARGUMENTS
  36. .AS ClientData clientDataPtr
  37. .AP Tcl_Interp *interp in
  38. Interpreter where package is needed or available.
  39. .AP "CONST char" *name in
  40. Name of package.
  41. .AP "CONST char" *version in
  42. A version string consisting of one or more decimal numbers
  43. separated by dots.
  44. .AP int exact in
  45. Non-zero means that only the particular version specified by
  46. fIversionfR is acceptable.
  47. Zero means that newer versions than fIversionfR are also
  48. acceptable as long as they have the same major version number
  49. as fIversionfR.
  50. .AP ClientData clientData in
  51. Arbitrary value to be associated with the package.
  52. .AP ClientData *clientDataPtr out
  53. Pointer to place to store the value associated with the matching
  54. package. It is only changed if the pointer is not NULL and the
  55. function completed successfully.
  56. .BE
  57. .SH DESCRIPTION
  58. .PP
  59. These procedures provide C-level interfaces to Tcl's package and
  60. version management facilities.
  61. .PP
  62. fBTcl_PkgRequirefR is equivalent to the fBpackage requirefR
  63. command, fBTcl_PkgPresentfR is equivalent to the fBpackage presentfR
  64. command, and fBTcl_PkgProvidefR is equivalent to the
  65. fBpackage providefR command.
  66. .PP
  67. See the documentation for the Tcl commands for details on what these
  68. procedures do.
  69. .PP
  70. If fBTcl_PkgPresentfR or fBTcl_PkgRequirefR complete successfully
  71. they return a pointer to the version string for the version of the package
  72. that is provided in the interpreter (which may be different than 
  73. fIversionfR); if an error occurs they return NULL and leave an error 
  74. message in the interpreter's result.
  75. .PP
  76. fBTcl_PkgProvidefR returns TCL_OK if it completes successfully;
  77. if an error occurs it returns TCL_ERROR and leaves an error message
  78. in the interpreter's result.
  79. .PP
  80. fBTcl_PkgProvideExfR, fBTcl_PkgPresentExfR and fBTcl_PkgRequireExfR
  81. allow the setting and retrieving of the client data associated with
  82. the package. In all other respects they are equivalent to the matching
  83. functions.
  84. .SH KEYWORDS
  85. package, present, provide, require, version