home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / usenet / altsrcs / 0 / 0998 / WatchInter.3 < prev   
Text File  |  1990-12-28  |  2KB  |  63 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_WatchInterp.man,v 1.1 89/05/15 16:15:39 ouster Exp $ SPRITE (Berkeley)
  10. '/" 
  11. .so \*(]ltmac.sprite
  12. .HS Tcl_WatchInterp tcl
  13. .VS
  14. .BS
  15. .SH NAME
  16. Tcl_WatchInterp \- arrange for callback when interpreter is deleted.
  17. .SH SYNOPSIS
  18. \fB#include <tcl.h>\fR
  19. .sp
  20. \fBTcl_WatchInterp\fR(\fIinterp\fR, \fIproc\fR, \fIclientData\fR)
  21. .SH ARGUMENTS
  22. .AS ClientData (*deleteProc)()
  23. .AP Tcl_Interp *interp in
  24. Interpreter whose deletion should be monitored.
  25. .AP char *cmdName in
  26. Name of new command.
  27. .AP void (*proc)() in
  28. Procedure to invoke just before \fIinterp\fR is deleted.
  29. .AP ClientData clientData in
  30. Arbitrary one-word value to pass to \fIproc\fR.
  31. .BE
  32.  
  33. .SH DESCRIPTION
  34. .PP
  35. \fBTcl_WatchInterp\fR arranges for \fIproc\fR to be called by
  36. \fBTcl_DeleteInterp\fR if/when \fIinterp\fR is deleted at some future
  37. time.  \fIProc\fR will be invoked just before the interpreter
  38. is deleted, but the interpreter will still be valid at the
  39. time of the call.  \fIProc\fR should have the following structure:
  40. .nf
  41. .RS
  42. void
  43. proc(\fIclientData\fR, \fIinterp\fR)
  44. .RS
  45. ClientData \fIclientData\fR;
  46. Tcl_Interp *\fIinterp\fR;
  47. .RE
  48. {
  49. }
  50. .RE
  51. .fi
  52. The \fIclientData\fP and \fIinterp\fR parameters are
  53. copies of the \fIclientData\fP and \fIinterp\fR arguments given
  54. to \fBTcl_WatchInterp\fR.
  55. Typically, \fIclientData\fR points to an application-specific
  56. data structure that \fIproc\fR uses to perform cleanup when an
  57. interpreter is about to go away.  \fIProc\fR does not return
  58. a value.
  59.  
  60. .SH KEYWORDS
  61. callback, delete, interpreter
  62. .VE
  63.