share/man/man3c_db/td_thr_validate.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_VALIDATE 3C_DB "Oct 20, 1998"
   7 .SH NAME
   8 td_thr_validate \- test a thread handle for validity
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... -lc_db [ \fIlibrary\fR... ]
  13 #include <proc_service.h>
  14 #include <thread_db.h>
  15
  16 \fBtd_err_e\fR \fBtd_thr_validate\fR(\fBconst td_thrhandle_t *\fR\fIth_p\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBtd_thr_validate()\fR function tests whether \fIth_p\fR is a valid thread
  23 handle. A valid thread handle can become invalid if its thread exits.
  24 .SH RETURN VALUES
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fBTD_OK\fR\fR
  29 .ad
  30 .RS 12n
  31 The call completed successfully.  \fIth_p\fR is a valid thread handle.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBTD_BADTH\fR\fR
  38 .ad
  39 .RS 12n
  40 \fIth_p\fR was  \fINULL.\fR
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBTD_DBERR\fR\fR
  47 .ad
  48 .RS 12n
  49 A call to one of the imported interface routines failed.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBTD_NOTHR\fR\fR
  56 .ad
  57 .RS 12n
  58 \fIth_p\fR is not a valid thread handle.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBTD_ERR\fR\fR
  65 .ad
  66 .RS 12n
  67 A \fBlibc_db\fR internal error occurred.
  68 .RE
  69
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for description of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 MT-Level        Safe
  84 .TE
  85
  86 .SH SEE ALSO
  87 .sp
  88 .LP
  89 \fBlibc_db\fR(3LIB), \fBattributes\fR(5)