share/man/man3c_db/td_ta_get_nthreads.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_TA_GET_NTHREADS 3C_DB "Oct 20, 1998"
   7 .SH NAME
   8 td_ta_get_nthreads \- gets the total number of threads in a process for libc_db
   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_ta_get_nthreads\fR(\fBconst td_thragent_t *\fR\fIta_p\fR, \fBint *\fR\fInthread_p\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBtd_ta_get_nthreads()\fR function returns the total number of threads in
  23 process \fIta_p\fR, including any system threads. System threads are those
  24 created by \fBlibc\fR or \fBlibc_db\fR on its own behalf. The number of threads
  25 is written into  *\fInthread_p\fR.
  26 .SH RETURN VALUES
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fBTD_OK\fR\fR
  31 .ad
  32 .RS 12n
  33 The call completed successfully.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBTD_BADTA\fR\fR
  40 .ad
  41 .RS 12n
  42 An invalid internal process handle was passed in.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBTD_BADPH\fR\fR
  49 .ad
  50 .RS 12n
  51 There is a \fINULL\fR external process handle associated with this internal
  52 process handle.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBTD_DBERR\fR\fR
  59 .ad
  60 .RS 12n
  61 A call to one of the imported interface routines failed.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBTD_ERR\fR\fR
  68 .ad
  69 .RS 12n
  70 The \fInthread_p\fR argument was \fINULL,\fR or a \fBlibc_db\fR internal error
  71 occurred.
  72 .RE
  73
  74 .SH ATTRIBUTES
  75 .sp
  76 .LP
  77 See \fBattributes\fR(5) for description of the following attributes:
  78 .sp
  79
  80 .sp
  81 .TS
  82 box;
  83 c | c
  84 l | l .
  85 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  86 _
  87 MT-Level        Safe
  88 .TE
  89
  90 .SH SEE ALSO
  91 .sp
  92 .LP
  93 \fBlibc_db\fR(3LIB), \fBattributes\fR(5), \fBthreads\fR(5)