usr/src/man/man3c/ttyslot.3c

   1 '\" te
   2 .\"  Copyright 1989 AT&T  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 TTYSLOT 3C "Oct 27, 1998"
   7 .SH NAME
   8 ttyslot \- find the slot of the current user  in the user accounting database
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <stdlib.h>
  13
  14 \fBint\fR \fBttyslot\fR(\fBvoid\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBttyslot()\fR function returns the index of the current user's entry in
  21 the user accounting database, \fB/var/adm/utmpx\fR. The current user's entry is
  22 an entry for which the \fButline\fR member matches the name of a terminal
  23 device associated with any of the process's file descriptors 0, 1 or 2. The
  24 index is an ordinal number representing the record number in the database of
  25 the current user's entry.  The first entry in the database is represented by
  26 the return value 0.
  27 .SH RETURN VALUES
  28 .sp
  29 .LP
  30 Upon successful completion, \fBttyslot()\fR returns the index of the current
  31 user's entry in the user accounting database. If an error was encountered while
  32 searching for the terminal name or if none of the above file descriptors are
  33 associated with a terminal device, \fB\(mi1\fR is returned.
  34 .SH FILES
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB/var/adm/utmpx\fR\fR
  39 .ad
  40 .RS 18n
  41 user access and accounting information
  42 .RE
  43
  44 .SH ATTRIBUTES
  45 .sp
  46 .LP
  47 See \fBattributes\fR(5) for descriptions of the following attributes:
  48 .sp
  49
  50 .sp
  51 .TS
  52 box;
  53 c | c
  54 l | l .
  55 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  56 _
  57 MT-Level        Safe
  58 .TE
  59
  60 .SH SEE ALSO
  61 .sp
  62 .LP
  63 \fBgetutent\fR(3C), \fBttyname\fR(3C), \fButmpx\fR(4), \fBattributes\fR(5)