Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
UserInfoC::UserInfoC(void)
UserInfoC::UserInfoC(StringC)
UserInfoC::UserInfoC(UIntT)
UserInfoC::Exists(void) const
UserInfoC::IsValid(void) const
UserInfoC::NullUser(void)
UserInfoC::Login(void) const
UserInfoC::FullName(void) const
UserInfoC::HomeDir(void) const
UserInfoC::Shell(void) const
UserInfoC::Hash(void) const
UserInfoC::UID(void) const
UserInfoC::Mail(StringC)
UserInfoC::Mail(StringC,StringC)
UserInfoC::Mail(StringC,TextFileC &)
UserInfoC::MailFile(StringC,StringC)
UserInfoC::operator==(const UserInfoC &) const
UserInfoC::operator!=(const UserInfoC &) const
UserInfoC::IsRoot(void) const
UserInfoC::WhoAmI(void)
UserInfoC::Init(UIntT)
UserInfoC::Init(StringC)
UserInfoC::Init(struct passwd *)
UserInfoC
 
User information.
 
include "amma/UserInfo.hh"
User Level:Default
Library:Msys
Example:exOption.cc
Section:Utilities.File System Utilities.System
In Scope:std

Comments:
This is a small object.

Variables:
BooleanT exists;
TRUE = is a real user.

UIntT uid;
id.

UIntT gid;
group id.

StringC login;
login.

StringC fullname;
Full name.

StringC homedir;
Home directory.

StringC shell;
Shell

Methods:
UserInfoC()
Default constructor.
Creates a null structure.

UserInfoC(StringC login)
Constructor from login.

UserInfoC(UIntT uid)
Constructor from user id.

BooleanT Exists() const
Does user exist ?

BooleanT IsValid() const
Could be a valid login ?
Mainly to check if UserInfoC was constructed with the default constructor.

void NullUser()
Make this entry invalid.

const StringC Login() const
Get login.

const StringC FullName() const
Get login.

const StringC HomeDir() const
Get home directory.

const StringC Shell() const
Get default shell.

UIntT Hash() const
Get a hash value.

UIntT UID() const
Access the user ID.

BooleanT Mail(StringC Content)
Attempt to mail the user
This takes a raw message and formats in appropriately. It expects the message to be in the following format.

To:xxx

Subject:xxx

(empty line)

Message contents.


BooleanT Mail(StringC Subject,StringC Content)
Attempt to mail the user

BooleanT Mail(StringC Subject,TextFileC & Content)
Attempt to mail the user

BooleanT MailFile(StringC Subject,StringC Filename)
Attempt to mail the user

BooleanT operator==(const UserInfoC & oth) const
Are two users equal ?

BooleanT operator!=(const UserInfoC & oth) const
Are two users unequal ?

BooleanT IsRoot() const
Test is user is root.

UserInfoC WhoAmI()
Get current user.

BooleanT Init(UIntT aUserid)
Initalise from userid.

BooleanT Init(StringC aLogin)
Initalise from a login.

void Init(struct passwd * pw)
Initalise from a password structure.


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001