tcldoc Tcl/Tk 9.0.4
/

Home › Tcl Library Procedures Tcl

Tcl_CreateCloseHandler C API

Arrange for callbacks when channels are closed

Also documents Tcl_DeleteCloseHandler

literal type exactly as shown argument replace with your value ?optional? may be omitted

Synopsis#

#include <tcl.h>

Tcl_CreateCloseHandler(channel, proc, clientData)#

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.

void *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(
        void *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.

Keywords#

callback · channel closing

Copyright#