GETUTENT

Section: Manuel du programmeur Linux (3)
Updated: 21 juillet 2003
Index


NOM
SYNOPSIS
DESCRIPTION
VALEUR RENVOYÉE
EXEMPLE
FICHIERS
CONFORMITÉ
VOIR AUSSI
TRADUCTION

NOM

getutent, getutid, getutline, pututline, setutent, endutent, utmpname - Accéder aux enregistrements utmp.

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() indique le nom du fichier au format utmp à utiliser avec les autres fonctions. Si utmpname() n'est pas appelé avant les autres fonctions, elles utiliseront le fichier _PATH_UTMP, défini dans <paths.h>.
setutent() ramène le pointeur au début du fichier utmp. Il est généralement conseillé d'appeler cette fonction au début du programme.
endutent() ferme le fichier utmp. Ceci devrait être appelé une fois que le programme a terminé ses accès au fichier.
getutent() lit une ligne du fichier utmp, à la position courante. Elle renvoie un pointeur sur une structure contenant les divers champs de la ligne.
getutid() effectue une recherche dans le fichier utmp, à partir de la position courante, en se basant sur ut. Si ut->ut_type vaut RUN_LVL, BOOT_TIME, NEW_TIME, ou OLD_TIME, getutid() recherchera le premier enregistrement dont le champ ut_type corresponde à ut->ut_type.
Si ut->ut_type vaut INIT_PROCESS, LOGIN_PROCESS, USER_PROCESS, ou DEAD_PROCESS, getutid() recherchera le premier enregistrement dont le champ ut_id corresponde à ut->ut_id.
getutline() effectue une recherche dans le fichier utmp, à partir de la position courante. Elle examine les enregistrements dont le champ ut_type soit USER_PROCESS ou LOGIN_PROCESS et renvoie le premier dont le champ ut_line corresponde à ut->ut_line.
pututline() écrit la structure utmp ut dans le fichier utmp. Elle utilise getutid() pour rechercher l'emplacement ou insérer le nouvel enregistrement. Si elle ne trouve pas d'emplacement approprié pututline() ajoutera le nouvel enregistrement à la fin du fichier.

VALEUR RENVOYÉE

getutent(), getutid(), getutline() et pututline() renvoient un pointeur sur une struct utmp statique, définie dans <utmp.h> comme ci-dessous, ou NULL en cas d'erreur.
struct utmp {
  short  ut_type;     /* Type de connexion         */
  pid_t  ut_pid;      /* PID de la connexion       */
  char   ut_line[12]; /* Périphérique de connexion */
  char   ut_id[4];    /* Nom de tty abrégé         */
  time_t ut_time;     /* Heure de connexion        */
  char   ut_user[8];  /* Nom d'utilisateur         */
  char   ut_host[16]; /* Nom d'hôte distant        */
  long   ut_addr;     /* Adresse IP d'hôte distant */
};

EXEMPLE

L'exemple suivant ajoute et retire un enregistrement utmp, en supposant qu'il est invoqué depuis un pseudo-terminal. Dans une véritable application, il faudrait vérifier les valeurs renvoyées par getpwuid() et 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 Avant d ajouter un enregistrement :;who");

   entry . ut_type = USER_PROCESS;
   entry . ut_pid  = getpid();
   
   strcpy (entry . ut_line, ttyname (0) + strlen ("/dev/"));

   /* ne fonctionne qu'avec les pseudo tty /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 Apres l ajout :;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 Apres suppression de l enregistrement :;who");

   endutent ();

   return (0);
}

FICHIERS

/var/run/utmp - Base de données des utilisateurs connectés.
/var/log/wtmp - Base de données des connexions passées.

CONFORMITÉ

XPG 2, SVID 2, Linux FSSTND 1.2
Dans XPG2 et SVID2 la fonction pututline() est décrite comme de type void, et c'est les cas sur de nombreux systèmes (AIX, HPUX, Linux libc5). HPUX introduit une nouvelle fonction _pututline() avec le prototype fourni plus haut pour pututline() (comme avec la libc5 de Linux).
Toutes ces fonctions sont obsolètes maintenant sur les systèmes non-Linux. POSIX 1003.1-2001, comme XPG4.2, ne propose aucune de ces fonctions, mais utilise plutôt
#include <utmpx.h>
struct utmpx *getutxent(void);
struct utmpx *getutxid(const struct utmpx *);
struct utmpx *getutxline(const struct utmpx *);
struct utmpx *pututxline(const struct utmpx *);
void setutxent(void);
void endutxent(void);
La structure utmpx est un sur-ensemble de la structure utmp, avec des champs supplémentaires, et une version plus large des champs existants. Les fichiers correspondants sont souvent /var/*/utmpx et /var/*/wtmpx.
D'un autre côté, la GlibC sous Linux n'utilise pas utmpx car sa structure utmp est déjà assez grande. Les fonctions getutxent etc. sont des alias pour getutent etc.

VOIR AUSSI

utmp(5)

TRADUCTION

Christophe Blaess, 1996-2003.