share/man/man3picltree/ptree_unregister_handler.3picltree

   1 '\" te
   2 .\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PTREE_UNREGISTER_HANDLER 3PICLTREE "Aug 1, 2000"
   7 .SH NAME
   8 ptree_unregister_handler \- unregister the event handler for the event
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile \fR\&.\|.\|. \fB-lpicltree\fR [\fIlibrary \&.\|.\|.\fR]
  13 #include <picltree.h>
  14
  15 \fBvoid\fR \fBptree_register_handler\fR(\fBconst char *\fR\fIename\fR,
  16      \fBvoid (*\fR\fIevt_handler\fR)(\fBconst char *\fR\fIename\fR, const void *\fIearg\fR,
  17      \fBsize_t\fR \fIsize\fR, \fBvoid *\fR\fIcookie\fR), \fBvoid *\fR\fIcookie\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBptree_unregister_handler()\fR function unregisters the event handler for
  24 the specified event. The argument \fIename\fR specifies the name of the PICL
  25 event for which to unregister the handler. The argument \fIevt_handler\fR
  26 specifies the event handler function. The argument \fIcookie\fR is the pointer
  27 to the caller-specific data given at the time of registration of the handler.
  28 .sp
  29 .LP
  30 If the handler being unregistered is currently executing, then this function
  31 will block until its completion. Because of this, locks acquired by the
  32 handlers should not be held across the call to \fBptree_unregister_handler()\fR
  33 or a deadlock may result.
  34 .sp
  35 .LP
  36 The \fBptree_unregister_handler()\fR function must not be invoked from the
  37 handler that is being unregistered.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 This function does not return a value.
  42 .SH ATTRIBUTES
  43 .sp
  44 .LP
  45 See \fBattributes\fR(5) for descriptions of the following attributes:
  46 .sp
  47
  48 .sp
  49 .TS
  50 box;
  51 c | c
  52 l | l .
  53 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  54 _
  55 MT-Level        MT-Safe
  56 .TE
  57
  58 .SH SEE ALSO
  59 .sp
  60 .LP
  61 \fBptree_register_handler\fR(3PICLTREE), \fBattributes\fR(5)