usr/src/man/man3tnf/tnfctl_close.3tnf

   1 '\" te
   2 .\"  Copyright (c) 1996 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 TNFCTL_CLOSE 3TNF "Mar 4, 1997"
   7 .SH NAME
   8 tnfctl_close \- close a tnfctl handle
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-ltnfctl\fR [ \fIlibrary\fR ... ]
  13 #include <tnf/tnfctl.h>
  14 \fBtnfctl_errcode_t\fR \fBtnfctl_close\fR(\fBtnfctl_handle_t *\fR\fIhndl\fR,
  15      \fBtnfctl_targ_op_t\fR \fIaction\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 \fBtnfctl_close()\fR is used to close a tnfctl handle and to free up the memory
  22 associated with the handle.  When the handle is closed, the tracing state and
  23 the states of the probes are not changed. \fBtnfctl_close()\fR can be used to
  24 close handles in any mode, that is, whether they were created by
  25 \fBtnfctl_internal_open\fR(3TNF), \fBtnfctl_pid_open\fR(3TNF),
  26 \fBtnfctl_exec_open\fR(3TNF), \fBtnfctl_indirect_open\fR(3TNF), or
  27 \fBtnfctl_kernel_open\fR(3TNF).
  28 .sp
  29 .LP
  30 The \fIaction\fR argument is only used in direct mode, that is, if \fIhndl\fR
  31 was created by \fBtnfctl_exec_open\fR(3TNF) or \fBtnfctl_pid_open\fR(3TNF). In
  32 direct mode, \fIaction\fR specifies whether the process will proceed, be
  33 killed, or remain suspended. \fIaction\fR may have the following values:
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBTNFCTL_TARG_DEFAULT\fR\fR
  38 .ad
  39 .RS 23n
  40 Kills the target process if  \fIhndl\fR was created with
  41 \fBtnfctl_exec_open\fR(3TNF), but lets it continue if it was created with
  42 \fBtnfctl_pid_open\fR(3TNF).
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBTNFCTL_TARG_KILL\fR\fR
  49 .ad
  50 .RS 23n
  51 Kills the target process.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBTNFCTL_TARG_RESUME\fR\fR
  58 .ad
  59 .RS 23n
  60 Allows the target process to continue.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBTNFCTL_TARG_SUSPEND\fR\fR
  67 .ad
  68 .RS 23n
  69 Leaves the target process suspended.  This is not a job control suspend. It is
  70 possible to attach to the process again with a debugger or with the
  71 \fBtnfctl_pid_open\fR(3TNF) interface.  The target process can also be
  72 continued with \fBprun\fR(1).
  73 .RE
  74
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 \fBtnfctl_close()\fR returns \fBTNFCTL_ERR_NONE\fR upon success.
  79 .SH ERRORS
  80 .sp
  81 .LP
  82 The following error codes apply to \fBtnfctl_close()\fR:
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBTNFCTL_ERR_BADARG\fR\fR
  87 .ad
  88 .RS 23n
  89 A bad argument was sent in  \fIaction\fR.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBTNFCTL_ERR_INTERNAL\fR\fR
  96 .ad
  97 .RS 23n
  98 An internal error occurred.
  99 .RE
 100
 101 .SH ATTRIBUTES
 102 .sp
 103 .LP
 104 See \fBattributes\fR(5) for descriptions of the following attributes:
 105 .sp
 106
 107 .sp
 108 .TS
 109 box;
 110 c | c
 111 l | l .
 112 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 113 _
 114 MT Level        MT-Safe
 115 .TE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBprex\fR(1), \fBprun\fR(1), \fBTNF_PROBE\fR(3TNF), \fBlibtnfctl\fR(3TNF),
 121 \fBtnfctl_exec_open\fR(3TNF), \fBtnfctl_indirect_open\fR(3TNF),
 122 \fBtnfctl_kernel_open\fR(3TNF), \fBtnfctl_pid_open\fR(3TNF),
 123 \fBtracing\fR(3TNF), \fBattributes\fR(5)