TclCallWhenDeleted(3) Tcl Library Procedures TclCallWhenDeleted(3)

NAME
       TclCallWhenDeleted,  TclDontCallWhenDeleted  -  Arrange  for callback
       when interpreter is deleted

SYNOPSIS
       ##iinncclluuddee <>

       TTccllCCaallllWWhheennDDeelleetteedd(interp, proc, clientData)

       TTccllDDoonnttCCaallllWWhheennDDeelleetteedd(interp, proc, clientData)

AARRGGUUMMEENNTTSS
       TclInterp             *interp      (in)      Interpreter with which to
                                                     associated callback.

       TclInterpDeleteProc   *proc        (in)      Procedure  to  call  when
                                                     interp is deleted.

       ClientData             clientData   (in)      Arbitrary one-word  value
                                                     to pass to proc.



DESCRIPTION
       TTccllCCaallllWWhheennDDeelleetteedd  arranges for proc to be called by TTccllDDeelleetteeIInntteerrpp
       if/when interp is deleted at some future time.  Proc  will  be  invoked
       just  before the interpreter is deleted, but the interpreter will still
       be valid at the time of the  call.   Proc  should  have  arguments  and
       result that match the type TTccllIInntteerrppDDeelleetteePPrroocc:
              typedef void TclInterpDeleteProc(
                ClientData clientData,
                TclInterp *interp);
       The  clientData  and interp parameters are copies of the clientData and
       interp arguments given to TTccllCCaallllWWhheennDDeelleetteedd.   Typically,  clientData
       points to an application-specific data structure that proc uses to per-
       form cleanup when an interpreter is about to go away.   Proc  does  not
       return a value.

       TTccllDDoonnttCCaallllWWhheennDDeelleetteedd  cancels a previous call to TTccllCCaallllWWhheennDDeelleetteedd
       with the same arguments, so that proc won't be called  after  all  when
       interp  is  deleted.   If  there  is  no deletion callback that matches
       interp, proc, and clientData then the call  to  TTccllDDoonnttCCaallllWWhheennDDeelleetteedd
       has no effect.


KKEEYYWWOORRDDSS
       callback, delete, interpreter



Tcl                                   7.0               TclCallWhenDeleted(3)