home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / usenet / altsrcs / 0 / 0998 / SetVar.3 < prev    next >
Encoding:
Text File  |  1990-12-28  |  1.7 KB  |  51 lines
  1. '\" Copyright 1989 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/src/lib/tcl/RCS/Tcl_SetVar.man,v 1.3 89/03/24 15:15:17 ouster Exp $ SPRITE (Berkeley)
  10. '\" 
  11. .so \*(]ltmac.sprite
  12. .HS Tcl_SetVar tcl
  13. .BS
  14. .SH NAME
  15. Tcl_SetVar \- change the value of a Tcl variable
  16. .SH SYNOPSIS
  17. .nf
  18. \fB#include <tcl.h>\fR
  19. .sp
  20. \fBTcl_SetVar\fR(\fIinterp, varName, newValue, global\fR)
  21. .SH ARGUMENTS
  22. .AS Tcl_Interp *interp
  23. .AP Tcl_Interp *interp in
  24. Interpreter in which to change variable.
  25. .AP char *varName in
  26. Name of variable.
  27. .AP char *newValue in
  28. New value for \fIvarName\fR
  29. .AP int global in
  30. If non-zero, then insist on interpreting \fIvarName\fR as a global
  31. variable, regardless of whether a procedure invocation is in
  32. progress.
  33. .BE
  34.  
  35. .SH DESCRIPTION
  36. .PP
  37. This is a utility procedure used by many of the Tcl commands.
  38. It changes the value of variable \fIvarName\fR in
  39. interpreter \fIinterp\fR, such that future calls to \fBTcl_GetVar\fR
  40. will return \fInewValue\fR as the value of \fIvarName\fR.
  41. \fBTcl_SetVar\fR uses the same rules for selecting
  42. a global or local variable as \fBTcl_GetVar\fR.  If \fIvarName\fR
  43. doesn't already exist, then a new variable is created.
  44. \fBTcl_SetVar\fR copies both \fIvarName\fR and \fInewValue\fR into
  45. its own private storage, so the caller may change the contents
  46. of these strings after \fBTcl_SetVar\fR returns without affecting
  47. the variable's value.
  48.  
  49. .SH KEYWORDS
  50. interpreter, variable
  51.