Reference

corelinux_Environment(3)

Environment is a class utility which encapsulates.

NAME

corelinux::Environment - Environment is a class utility which encapsulates.

SYNOPSIS

#include <Environment.hpp>

Public Member Functions

bool operator== (EnvironmentCref) const
Equality operator.

Static Public Member Functions

UserIdentifier getUserId (void)
Retreive the real user id for the current process. UserIdentifier getEffectiveUserId (void)
Retreive the effective user id for the current process. GroupIdentifier getGroupId (void)
Retreive the real group id for the current process. GroupIdentifier getEffectiveGroupId (void)
Retreive the effective group id for the current process. CharPtr getEnvironmentValue (CharCptr)
Retrieve the environmental value variable from the (name=value) pair. Int setEnvironmentNameValue (CharPtr)
Sets an environment name=value. Int setupCommonAccess (CharCptr, const CreateDisposition &)
Basically, creates a filename for use by those Linux system api that require a key (IPC mainly). Int removeCommonAccess (CharCptr)
The reverse of setupCommonAccess. ProcessIdentifier getProcessGroupId (void)
Retrieve the process group id for the current process. ProcessIdentifier getProcessGroupId (ProcessIdentifierRef)
Retrieve the process group id for a specific process. void setThreadPriority (ProcessIdentifier, Int)
set priority for a specific process Int getThreadPriority (ProcessIdentifier)
get priority for a specific process

Protected Member Functions

Environment (EnvironmentCref) throw (Assertion)
EnvironmentRef operator= (EnvironmentCref) throw (Assertion)

Detailed Description

Environment is a class utility which encapsulates.

Member Function Documentation

CharPtr corelinux::Environment::getEnvironmentValue (CharCptr) [static]

Retrieve the environmental value variable from the (name=value) pair. Same behavior as in POSIX getenv

Parameters:

Char const pointer to key (name) to find value for

Returns:

Char pointer to the value or null if not found

Int corelinux::Environment::removeCommonAccess (CharCptr) [static]

The reverse of setupCommonAccess. Parameters:

Char pointer to fully qualified name

Returns:

Int indicating failure (-1)

Int corelinux::Environment::setEnvironmentNameValue (CharPtr) [static]

Sets an environment name=value. Same behavior and return as POSIX putenv.

Parameters:

Char pointer to string with 'NAME=VALUE'

Returns:

Int 0 for success, -1 otherwise

Int corelinux::Environment::setupCommonAccess (CharCptr, const CreateDisposition &) [static]

Basically, creates a filename for use by those Linux system api that require a key (IPC mainly). Parameters:

Char pointer to fully qualified name
CreateDisposition disposition of object

Returns:

Int indicating failure (-1)

Author

Generated automatically by Doxygen for CoreLinux++ from the source code.

History