Pegasus InfoCorp: Web site design and web software development company

GETUTENT (3)

access utmp file entries

SYNOPSIS

    #include <utmp.h> struct utmp *getutent(void); struct utmp *getutid(struct utmp * ut ); struct utmp *getutline(struct utmp * ut ); void pututline(struct utmp * ut ); void setutent(void); void endutent(void); void utmpname(const char * file );

DESCRIPTION

    utmpname() sets the name of the utmp-format file for the other utmp functions to access. If utmpname() is not used to set the filename before the other functions are used, they assume _PATH_UTMP, as defined in <paths.h>.

    setutent() rewinds the file pointer to the beginning of the utmp file. It is generally a Good Idea to call it before any of the other functions.

    endutent() closes the utmp file. It should be called when the user code is done accessing the file with the other functions.

    getutent() reads a line from the current file position in the utmp file. It returns a pointer to a structure containing the fields of the line.

    getutid() searches forward from the current file position in the utmp file based upon ut. If ut->ut_type is RUN_LVL, BOOT_TIME, NEW_TIME, or OLD_TIME, getutid() will find the first entry whose ut_type field matches ut->ut_type. If ut->ut_type is one of INIT_PROCESS, LOGIN_PROCESS, USER_PROCESS, or DEAD_PROCESS, getutid() will find the first entry whose ut_id field matches ut->ut_id.

    getutline() searches forward from the current file position in the utmp file. It scans entries whose ut_type is USER_PROCESS or LOGIN_PROCESS and returns the first one whose ut_line field matches ut->ut_line.

    pututline() writes the utmp structure ut into the utmp file. It uses getutid() to search for the proper place in the file to insert the new entry. If it cannot find an appropriate slot for ut, pututline() will append the new entry to the end of the file.

RETURN VALUE

    getutent(), getutid(), and getutline() return a pointer to a static struct utmp.

ERRORS

    On error, (struct utmp*)0 will be returned.

EXAMPLE

    The following example adds and removes a utmp record, assuming it is run from within a pseudo terminal. For usage in a real application, you should check the return values of getpwuid() and ttyname().

    #include <string.h>
    #include <stdlib.h>
    #include <pwd.h>
    #include <unistd.h>
    #include <utmp.h>
    

    int main(int argc, char *argv[]) { struct utmp entry;

    system("echo before adding entry:;who");

    entry.ut_type=USER_PROCESS; entry.ut_pid=getpid(); strcpy(entry.ut_line,ttyname(0)+strlen("/dev/")); /* only correct for ptys named /dev/tty[pqr][0-9a-z] */ strcpy(entry.ut_id,ttyname(0)+strlen("/dev/tty")); time(&entry.ut_time); strcpy(entry.ut_user,getpwuid(getuid())->pw_name); memset(entry.ut_host,0,UT_HOSTSIZE); entry.ut_addr=0; setutent(); pututline(&entry);

    system("echo after adding entry:;who");

    entry.ut_type=DEAD_PROCESS; memset(entry.ut_line,0,UT_LINESIZE); entry.ut_time=0; memset(entry.ut_user,0,UT_NAMESIZE); setutent(); pututline(&entry);

    system("echo after removing entry:;who");

    endutent(); return 0; }

FILES

    /var/run/utmp database of currently logged-in users /var/log/wtmp database of past user logins

CONFORMING TO

    XPG 2, SVID 2, Linux FSSTND 1.2

SEE ALSO

    utmp(5) man3/getutent 3 man3/getutent 3 ' " ' " Copyright(c) 1994 The Regents of the University of California ' " Copyright(c) 1994-1996 Sun Microsystems Inc ' " ' " See the file "license terms" for information on usage and redistribution ' " of this file and for a DISCLAIMER OF ALL WARRANTIES ' " ' " RCS: @(#) $Id: GetVisual 3 v 1 2 1998/09/14 18:22:51 stanton Exp $ ' " ' " The definitions below are for supplemental macros used in Tcl/Tk ' " manual entries ' " ' " AP type name in/out ?indent? ' " Start paragraph describing an argument to a library procedure ' " type is type of argument(int etc ) in/out is either "in" "out" ' " or "in/out" to describe whether procedure reads or modifies arg ' " and indent is equivalent to second arg of IP(shouldn't ever be ' " needed; use AS below instead) ' " ' " AS ?type? ?name? ' " Give maximum sizes of arguments for setting tab stops Type and ' " name are examples of largest possible arguments that will be passed ' " to AP later If args are omitted default tab stops are used ' " ' " BS ' " Start box enclosure From here until next BE everything will be ' " enclosed in one large box ' " ' " BE ' " End of box enclosure ' " ' " CS ' " Begin code excerpt ' " ' " CE ' " End code excerpt ' " ' " VS ?version? ?br? ' " Begin vertical sidebar for use in marking newly-changed parts ' " of man pages The first argument is ignored and used for recording ' " the version when the VS was added so that the sidebars can be ' " found and removed when they reach a certain age If another argument ' " is present then a line break is forced before starting the sidebar ' " ' " VE ' " End of vertical sidebar ' " ' " DS ' " Begin an indented unfilled display ' " ' " DE ' " End of indented unfilled display ' " ' " SO ' " Start of list of standard options for a Tk widget The ' " options follow on successive lines in four columns separated ' " by tabs ' " ' " SE ' " End of list of standard options for a Tk widget ' " ' " OP cmdName dbName dbClass ' " Start of description of a specific option cmdName gives the ' " option's name as specified in the class command dbName gives ' " the option's name in the option database and dbClass gives ' " the option's class in the option database ' " ' " UL arg1 arg2 ' " Print arg1 underlined then print arg2 normally ' " ' " RCS: @(#) $Id: man macros v 1 2 1998/09/14 18:39:54 stanton Exp $ ' " ' " # Set up traps and other miscellaneous stuff for Tcl/Tk man pages t wh -1 3i ^B ^l n( l b ' " # Start an argument description AP !" $4"" TP $4 { !" $2"" TP n()Cu 15