This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

This manual page is associated with the Mac OS X developer tools. The software or headers described may not be present on your Mac OS X installation until you install the developer tools package. This package is available on your Mac OS X installation DVD, and the latest versions can be downloaded from developer.apple.com.

For more information about the manual page format, see the manual page for manpages(5).

Tcl_CreateCloseHandler(3)                  Tcl Library Procedures                  Tcl_CreateCloseHandler(3)



____________________________________________________________________________________________________________

NAME
       Tcl_CreateCloseHandler, Tcl_DeleteCloseHandler - arrange for callbacks when channels are closed

SYNOPSIS
       #include <tcl.h>

       void
       Tcl_CreateCloseHandler(channel, proc, clientData)

       void
       Tcl_DeleteCloseHandler(channel, proc, clientData)


ARGUMENTS
       Tcl_Channel     channel        (in)      The  channel for which to create or delete a close callback.

       Tcl_CloseProc   *proc          (in)      The procedure to call as the callback.

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


DESCRIPTION
       Tcl_CreateCloseHandler arranges for proc to be called  when  channel  is  closed  with  Tcl_Close  or
       Tcl_UnregisterChannel, or using the Tcl close command.  Proc should match the following prototype:

              typedef void Tcl_CloseProc(
                ClientData clientData);

       The clientData is the same as the value provided in the call to Tcl_CreateCloseHandler.

       Tcl_DeleteCloseHandler  removes a close callback for channel.  The proc and clientData identify which
       close callback to remove; Tcl_DeleteCloseHandler does nothing if its proc and clientData arguments do
       not match the proc and clientData for a  close handler for channel.


SEE ALSO
       close(n), Tcl_Close(3), Tcl_UnregisterChannel(3)


KEYWORDS
       callback, channel closing



Tcl                                                  7.5                           Tcl_CreateCloseHandler(3)