utempter_remove_record(3)

utempter_remove_record3

Utempter compatibility interface

Part of utempter_add_record(3).

Usage

#include <utempter.h>

int

utempter_add_record(int fd, const char *host);

int

utempter_remove_added_record(void);

int

utempter_remove_record(int fd);

void

addToUtmp(const char *pty, const char *host, int fd);

void

removeFromUtmp(void);

void

removeLineFromUtmp(const char *pty, int fd);

Library

library “libulog”

Overview

The utempter_add_record() and addToUtmp() functions add a login record to the database for the TTY belonging to the pseudo-terminal master file descriptor fd, using the username corresponding with the real user ID of the calling process and the optional hostname host. These functions are equivalent to ulog_login_pseudo(3).

The utempter_remove_record() and removeLineFromUtmp() functions mark the login session as being closed for the TTY belonging to the pseudo-terminal master file descriptor fd. These functions are equivalent to ulog_logout_pseudo(3).

The utempter_remove_added_record() and removeFromUtmp() functions have the same properties as the previously mentioned functions, except that they use an internally cached value of the file descriptor passed to the login functions.

The pty arguments of addToUtmp() and removeLineFromUtmp() are unused.

Return values

In this implementation, the utempter_add_record(), utempter_remove_added_record() and utempter_remove_record() always return a value of 0.

Releases

34 releases since FreeBSD 9.0-RELEASE; the text changed 20 times.

  1. 9.0
  2. 9.1
  3. 9.2
  4. 9.3
  5. 10.0
  6. 10.1
  7. 10.2
  8. 10.3
  9. 10.4
  10. 11.0
  11. 11.1
  12. 11.2
  13. 11.3
  14. 11.4
  15. 12.0
  16. 12.1
  17. 12.2
  18. 12.3
  19. 12.4
  20. 13.0–13.2
  21. 13.3–16.0

History

These functions appeared in FreeBSD 9.0.

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.