Tcl_CreateCloseHandler - arrange for callbacks when channels are closed
#include <tcl.h> void Tcl_CreateCloseHandler(channel, proc, clientData) void Tcl_DeleteCloseHandler(channel, proc, clientData)
Tcl Library Procedures Tcl_CreateCloseHandler(3tcl)
______________________________________________________________________________
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_Delete-
CloseHandler does nothing if its proc and clientData arguments do not
match the proc and clientData for a close handler for channel.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | runtime/tcl-8 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
close(n), Tcl_Close(3), Tcl_UnregisterChannel(3)
KEYWORDS
callback, channel closing
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from http://prdownloads.sourceforge.net/tcl/tcl-
core8.6.7-src.tar.gz.
Further information about this software can be found on the open source
community website at https://www.tcl.tk/.
Tcl 7.5
Tcl_CreateCloseHandler(3tcl)