endutxent(3posix)
NAME
endutxent, getutxent, getutxid, getutxline, pututxline, setutxent --- user accounting database functions
SYNOPSIS
#include <utmpx.h> void endutxent(void); struct utmpx *getutxent(void); struct utmpx *getutxid(const struct utmpx *id); struct utmpx *getutxline(const struct utmpx *line); struct utmpx *pututxline(const struct utmpx *utmpx); void setutxent(void);
DESCRIPTION
These functions shall provide access to the user accounting database.
The getutxent() function shall read the next entry from the user
accounting database. If the database is not already open, it shall
open it. If it reaches the end of the database, it shall fail.
The getutxid() function shall search forward from the current point in
the database. If the ut_type value of the utmpx structure pointed to
by id is BOOT_TIME, OLD_TIME, or NEW_TIME, then it shall stop when it
finds an entry with a matching ut_type value. If the ut_type value is
INIT_PROCESS, LOGIN_PROCESS, USER_PROCESS, or DEAD_PROCESS, then it
shall stop when it finds an entry whose type is one of these four and
whose ut_id member matches the ut_id member of the utmpx structure
pointed to by id. If the end of the database is reached without a
match, getutxid() shall fail.
The getutxline() function shall search forward from the current point
in the database until it finds an entry of the type LOGIN_PROCESS or
USER_PROCESS which also has a ut_line value matching that in the utmpx
structure pointed to by line. If the end of the database is reached
without a match, getutxline() shall fail.
The getutxid() or getutxline() function may cache data. For this
reason, to use getutxline() to search for multiple occurrences, the
application shall zero out the static data after each success, or
getutxline() may return a pointer to the same utmpx structure.
There is one exception to the rule about clearing the structure before
further reads are done. The implicit read done by pututxline() (if it
finds that it is not already at the correct place in the user
accounting database) shall not modify the static structure returned by
getutxent(), getutxid(), or getutxline(), if the application has
modified this structure and passed the pointer back to pututxline().
For all entries that match a request, the ut_type member indicates the
type of the entry. Other members of the entry shall contain meaningful
data based on the value of the ut_type member as follows:
ut_type Member Other Members with Meaningful Data
EMPTY No others
BOOT_TIME ut_tv
OLD_TIME ut_tv
NEW_TIME ut_tv
USER_PROCESS ut_id, ut_user (login name of the user), ut_line, ut_pid, ut_tv
INIT_PROCESS ut_id, ut_pid, ut_tv
LOGIN_PROCESS ut_id, ut_user (implementation-defined name of the login
process), ut_line, ut_pid, ut_tv
DEAD_PROCESS ut_id, ut_pid, ut_tv
An implementation that provides extended security controls may impose
implementation-defined restrictions on accessing the user accounting
database. In particular, the system may deny the existence of some or
all of the user accounting database entries associated with users other
than the caller.
If the process has appropriate privileges, the pututxline() function
shall write out the structure into the user accounting database. It
shall search for a record as if by getutxid() that satisfies the
request. If this search succeeds, then the entry shall be replaced.
Otherwise, a new entry shall be made at the end of the user accounting
database.
The endutxent() function shall close the user accounting database.
The setutxent() function shall reset the input to the beginning of the
database. This should be done before each search for a new entry if it
is desired that the entire database be examined.
These functions need not be thread-safe.
RETURN VALUE
Upon successful completion, getutxent(), getutxid(), and getutxline() shall return a pointer to a utmpx structure containing a copy of the requested entry in the user accounting database. Otherwise, a null pointer shall be returned. The return value may point to a static area which is overwritten by a subsequent call to getutxid() or getutxline(). Upon successful completion, pututxline() shall return a pointer to a utmpx structure containing a copy of the entry added to the user accounting database. Otherwise, a null pointer shall be returned. The endutxent() and setutxent() functions shall not return a value.
ERRORS
No errors are defined for the endutxent(), getutxent(), getutxid(), getutxline(), and setutxent() functions. The pututxline() function may fail if: EPERM The process does not have appropriate privileges. The following sections are informative.
EXAMPLES
None.
APPLICATION USAGE
The sizes of the arrays in the structure can be found using the sizeof operator.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
The Base Definitions volume of POSIX.12008, <utmpx.h>
COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, Copyright (C) 2013 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. (This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.unix.org/online.html . Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
