Facade encapsulating OS specific user functionality. More...

Typedefs
typedef uid_t	UserID

Functions
String	getEffectiveUserId ()
	Get the effective user id. More...

String	getCurrentUserName ()

String	getUserName (UserID uid, bool &success)
	If the username is invalid, or if getUserName() fails for any other reason, 'success' will be set to false. More...

UserID	getUserId (const String &userName, bool &validUserName)
	Convert a textual username into a platform native user type. More...

Variables
const UserID	INVALID_USERID = UserID(~0)

Detailed Description

Facade encapsulating OS specific user functionality.

Typedef Documentation

◆ UserID

typedef uid_t BLOCXX_NAMESPACE::UserUtils::UserID

Definition at line 116 of file UserUtils.hpp.

Function Documentation

◆ getCurrentUserName()

BLOCXX_COMMON_API String BLOCXX_NAMESPACE::UserUtils::getCurrentUserName ( )

Definition at line 210 of file UserUtils.cpp.

◆ getEffectiveUserId()

BLOCXX_COMMON_API String BLOCXX_NAMESPACE::UserUtils::getEffectiveUserId ( )

Get the effective user id.

On POSIX platforms this calls geteuid().

Definition at line 151 of file UserUtils.cpp.

References getUserName().

◆ getUserId()

BLOCXX_COMMON_API UserID BLOCXX_NAMESPACE::UserUtils::getUserId	(	const String &	userName,
		bool &	validUserName
	)

Convert a textual username into a platform native user type.

Parameters

userName	The user name to convert.
validUserName	Out param set to true if the conversion was successful, false otherwise.

Returns: The user id corresponding to userName.

Definition at line 326 of file UserUtils.cpp.

◆ getUserName()

BLOCXX_COMMON_API String BLOCXX_NAMESPACE::UserUtils::getUserName	(	UserID	uid,
		bool &	success
	)

If the username is invalid, or if getUserName() fails for any other reason, 'success' will be set to false.

On success, 'success' is set to true.

Definition at line 269 of file UserUtils.cpp.

Referenced by getEffectiveUserId().

Variable Documentation

◆ INVALID_USERID

const UserID BLOCXX_NAMESPACE::UserUtils::INVALID_USERID = UserID(~0)

Definition at line 117 of file UserUtils.hpp.

Typedefs

Functions

Variables