|
|
HP-UX Reference Volume 4 of 5 > ggetpwent(3C) |
|
NAMEgetpwent(), getpwuid(), getpwuid_r(), getpwnam(), getpwnam_r(), setpwent(), endpwent(), fgetpwent(), — get password file entry SYNOPSIS#include <pwd.h> struct passwd *getpwent(void); struct passwd *getpwuid(uid_t uid); int getpwuid_r(uid_t uid, struct passwd *pwd, char *buffer, size_t buflen, struct passwd **result); struct passwd *getpwnam(const char *name); int getpwnam_r(char *name, struct passwd *pwd, char *buffer, size_t buflen, struct passwd **result); void setpwent(void); void endpwent(void); struct passwd *fgetpwent(FILE *stream); DESCRIPTIONgetpwent(), getpwuid(), and getpwnam() are used to obtain password entries, and return a pointer to an object of passwd structure. An entry may come from any of the sources for passwd specified in the /etc/nsswitch.conf file. See nsswitch.conf(4). The passwd structure is defined in <pwd.h> and includes the following members: char *pw_name; /* user name */ char *pw_passwd; /* encrypted password */ uid_t pw_uid; /* user id */ gid_t pw_gid; /* group id */ char *pw_age; /* password aging */ char *pw_comment; /* unused */ char *pw_gecos; /* user fullname, office, extension, homephone*/ char *pw_dir; /* initial directory */ char *pw_shell; /* initial shell */ aid_t pw_audid; /* numerical audit id */ int pw_audflg; /* numerical audit flag */ The pw_comment field is unused; for more information on the other fields, refer to passwd(4).
Obsolescent Interfacesgetpwent_r(), setpwent_r(), endpwent_r(), fgetpwent_r() get password file entry. Reentrant Interfacesgetpwuid_r(), and getpwnam_r() both update the structpasswd pointed to by pwd and store a pointer to that structure at the location pointed to by result. The structure shall contain an entry from the user database with a matching uid or name. Storage referenced by the passwd structure pointed to by pwd shall be allocated from the memory provided with the buffer parameter, which is buflen in size. The maximum size needed for this buffer can be determined with the _SC_GETPW_R_SIZE_MAX sysconf() parameter. A NULL pointer is returned at the location pointed to by result on error or if the requested entry is not found. A buffer length of 1024 is recommended. SECURITY FEATURESIf the system has been converted to a trusted system, the password, audit ID, and audit flag are not returned. The password will be the default * that is in /etc/passwd and the audit ID and audit flag will be set to -1. On trusted systems, if it is not necessary to obtain information from the regular password file, /etc/passwd, users should use getprpwent() to access the protected password database. See getprpwent(3) and getspwent(3X). putpwent() affects only /etc/passwd; the audit ID and audit flag in the password structure are ignored. putprpwnam() must be used to modify the protected password databse entries. See getprpwent(3). APPLICATION USAGEgetpwuid() and getpwnam() are not thread-safe. getpwent(), setpwent(), endpwent(), fgetpwent(), getpwuid_r(), and getpwnam_r() are thread-safe. These interfaces are not async-cancel-safe. A cancellation point may occur when a thread is executing any of these interfaces. RETURN VALUEgetpwent(), getpwuid(), getpwnam(), and fgetpwent() return a NULL pointer if an end-of-file or error is encountered on reading. Otherwise, the return value points to an internal static area containing a valid passwd structure. getpwuid_r() and getpwnam_r() return zero upon success. Otherwise, an error number is returned to indicate the error. ERRORSgetpwent(), getpwuid(), getpwnam(), and fgetpwent() fail if any of the following are true:
WARNINGSThe value returned by getpwent(), getpwuid(), getpwnam(), and fgetpwent() points to a single static area that is overwritten by each call to any of the functions, so it must be copied if it is to be saved. The following fields have numerical limitations as noted:
Users of getpwuid_r() and getpwnam_r() should note that these interfaces now conform with POSIX.1c. getpwent_r(), setpwent_r(), endpwent_r() and fgetpwent_r() are obsolescent interfaces. These interfaces and the old prototypes of getpwuid_r() and getpwnam_r() are supported for compatibility with existing DCE applications only. The interfaces getpwuid(), getpwnam(), getpwent(), setpwent(), endpwent(), fgetpwent(), getpwuid_r() and getpwnam_r() use the Dynamic Name Service Switch.(See nsswitch.conf(4).) An application that uses these interfaces cannot be fully archive bound. EXAMPLEThe following code excerpt prints name and uid of user logged in on this terminal: struct passwd pwd; struct passwd *result; char logBuffer [1024]; char pwdBuffer [1024]; if (getlogin_r (loginBuffer, 1024) == 0) if (getpwnam_r (logBuffer, &pwd, pwdBuffer, 1024, &result) == 0) printf ("Name = %s; uid = %d\n", pwd.pw_name, pwd.pw_uid); AUTHORgetpwent(), getpwuid(), getpwnam(), setpwent(), endpwent(), and fgetpwent() were developed by Sun and HP. |
|