usr/src/man/man3c_db/td_thr_sleepinfo.3c_db

   1 '\" te
   2 .\"  Copyright (c) 1998 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 TD_THR_SLEEPINFO 3C_DB "Oct 20, 1998"
   7 .SH NAME
   8 td_thr_sleepinfo \- return the synchronization handle for the object on which a
   9 thread is blocked
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR... ] \fIfile\fR... -lc_db [ \fIlibrary\fR... ]
  14 #include <proc_service.h>
  15 #include <thread_db.h>
  16
  17 \fBtd_err_e\fR \fBtd_thr_sleepinfo\fR(\fBconst td_thrhandle_t *\fR\fIth_p\fR, \fBtd_synchandle_t *\fR\fIsh_p\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBtd_thr_sleepinfo()\fR function returns in  *\fIsh_p\fR the handle of the
  24 synchronization object on which a sleeping thread is blocked.
  25 .SH RETURN VALUES
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fBTD_OK\fR\fR
  30 .ad
  31 .RS 12n
  32 The call completed successfully.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fBTD_BADTH\fR\fR
  39 .ad
  40 .RS 12n
  41 An invalid thread handle was passed in.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBTD_DBERR\fR\fR
  48 .ad
  49 .RS 12n
  50 A call to one of the imported interface routines failed.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBTD_ERR\fR\fR
  57 .ad
  58 .RS 12n
  59 The thread \fIth_p\fR is not blocked on a synchronization object, or a
  60 \fBlibc_db\fR internal error occurred.
  61 .RE
  62
  63 .SH ATTRIBUTES
  64 .sp
  65 .LP
  66 See \fBattributes\fR(5) for description of the following attributes:
  67 .sp
  68
  69 .sp
  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 MT-Level        Safe
  77 .TE
  78
  79 .SH SEE ALSO
  80 .sp
  81 .LP
  82 \fBlibc_db\fR(3LIB), \fBattributes\fR(5)