RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/group__Environment.html below:

NCBI C++ ToolKit: Access To Shell Environment

virtual const char * CArgumentsException::GetErrCodeString (void) const override Translate from the error code value to its string representation. More...
CArgumentsException::NCBI_EXCEPTION_DEFAULT (CArgumentsException, CCoreException) CNcbiEnvironment::CNcbiEnvironment (void) Constructor. More...
CNcbiEnvironment::CNcbiEnvironment (const char *const *envp) Constructor with the envp parameter. More...
virtual CNcbiEnvironment::~CNcbiEnvironment (void) Destructor. More...
void CNcbiEnvironment::Reset (const char *const *envp=0) Reset environment. More...
const string & CNcbiEnvironment::Get (const string &name, bool *found=NULL) const Get environment value by name. More...
void CNcbiEnvironment::Enumerate (list< string > &names, const string &prefix=kEmptyStr) const Find all variable names starting with an optional prefix. More...
void CNcbiEnvironment::Set (const string &name, const string &value) Set an environment variable by name. More...
void CNcbiEnvironment::Unset (const string &name) Delete an environment variable by name. More...
virtual string CNcbiEnvironment::Load (const string &name, bool &found) const Load value of specified environment variable. More...
CNcbiEnvironment::SEnvValue::SEnvValue (void) CNcbiEnvironment::SEnvValue::SEnvValue (const string &v, const TXChar *p) CAutoEnvironmentVariable::CAutoEnvironmentVariable (const CTempString &var_name, const CTempString &value="1", CNcbiEnvironment *env=NULL) Initializes the environment variable passed as an argument to the corresponding value ("1" by default) More...
CAutoEnvironmentVariable::~CAutoEnvironmentVariable () Destructor which restores the modifications made in the environment by this class. More...
CEnvironmentCleaner::CEnvironmentCleaner (const char *s=NULL,...) Immediately clean some settings, to be passed in as a NULL-terminated sequence of C strings. More...
void CEnvironmentCleaner::Clean (const string &name) Clean the specified setting. More...
CNcbiArguments::CNcbiArguments (int argc, const char *const *argv, const string &program_name=kEmptyStr, const string &real_name=kEmptyStr) Constructor. More...
virtual CNcbiArguments::~CNcbiArguments (void) Destructor. More...
CNcbiArguments::CNcbiArguments (const CNcbiArguments &args) Copy constructor. More...
CNcbiArguments & CNcbiArguments::operator= (const CNcbiArguments &args) Assignment operator. More...
void CNcbiArguments::Reset (int argc, const char *const *argv, const string &program_name=kEmptyStr, const string &real_name=kEmptyStr) Reset arguments. More...
SIZE_TYPE CNcbiArguments::Size (void) const Get size (number) of arguments. More...
const string & CNcbiArguments::operator[] (SIZE_TYPE pos) const Get the argument specified by "pos". More...
void CNcbiArguments::Add (const string &arg) Add a new argument. More...
void CNcbiArguments::Shift (int n=1) Delete arguments from 1 to n. More...
const string & CNcbiArguments::GetProgramName (EFollowLinks follow_links=eIgnoreLinks) const Get program name. More...
string CNcbiArguments::GetProgramBasename (EFollowLinks follow_links=eIgnoreLinks) const Get program base name. More...
string CNcbiArguments::GetProgramDirname (EFollowLinks follow_links=eIgnoreLinks) const Get program directory name. More...
void CNcbiArguments::SetProgramName (const string &program_name, const string &real_name=kEmptyStr) Set program name. More...
◆ TCache ◆ EErrCode

Error types that arguments processing can generate.

Enumerator eNegativeArgc

Negative argc value.

eNoArgs

No arguments.

Definition at line 79 of file ncbienv.hpp.

◆ Add() ◆ CAutoEnvironmentVariable()

Initializes the environment variable passed as an argument to the corresponding value ("1" by default)

Parameters: var_name environment variable name [in] value value to set the environment variable to [in]

Definition at line 222 of file ncbienv.cpp.

References eNoOwnership, env, eTakeOwnership, CNcbiEnvironment::Get(), CNcbiApplicationAPI::InstanceGuard(), CAutoEnvironmentVariable::m_Env, CAutoEnvironmentVariable::m_PrevValue, CAutoEnvironmentVariable::m_VariableName, CAutoEnvironmentVariable::m_WasSet, NULL, AutoPtr< X, Del >::reset(), CNcbiEnvironment::Set(), CNcbiApplicationAPI::SetEnvironment(), CNcbiEnvironment::Unset(), and rapidjson::value.

◆ CEnvironmentCleaner() CEnvironmentCleaner::CEnvironmentCleaner ( const char * s = NULL, ... ) ◆ Clean() void CEnvironmentCleaner::Clean ( const string & name ) ◆ CNcbiArguments() [1/2] ◆ CNcbiArguments() [2/2]

Constructor.

Parameters: argc Standard argument count argv Standard argument vector program_name Program name real_name Resolved name

Definition at line 304 of file ncbienv.cpp.

References CNcbiArguments::Reset().

◆ CNcbiEnvironment() [1/2] CNcbiEnvironment::CNcbiEnvironment ( const char *const * envp ) ◆ CNcbiEnvironment() [2/2] CNcbiEnvironment::CNcbiEnvironment ( void ) ◆ Enumerate()

Find all variable names starting with an optional prefix.

Definition at line 133 of file ncbienv.cpp.

References map_checker< Container >::end(), kEmptyXCStr, map_checker< Container >::lower_bound(), CNcbiEnvironment::m_Cache, CNcbiEnvironment::m_CacheMutex, names, and NStr::StartsWith().

Referenced by CCgiEnvHolder::CCgiEnvHolder(), CCgiApplication::LogRequest(), CCgiSampleApplication::ProcessPrintEnvironment(), WriteEnvironment(), CEnvironmentRegistry::x_Empty(), CEnvironmentRegistry::x_Enumerate(), and CEnvironmentRegistry::x_HasSection().

◆ Get()

Get environment value by name.

If environmnent value is not cached then call "Load(name)" to load the environmnent value. The loaded name/value pair will then be cached, too, after the call to "Get()".

Definition at line 109 of file ncbienv.cpp.

References map_checker< Container >::empty(), map_checker< Container >::end(), map_checker< Container >::find(), i, kEmptyStr, kEmptyXCStr, CNcbiEnvironment::Load(), CNcbiEnvironment::m_Cache, CNcbiEnvironment::m_CacheMutex, and NULL.

Referenced by CMsvcConfigure::AnalyzeDefines(), BlastFindMatrixPath(), CAutoEnvironmentVariable::CAutoEnvironmentVariable(), CCgiEnvHolder::CCgiEnvHolder(), CCgiUserAgent::CCgiUserAgent(), CNcbiApplogApp::Cmd_Health(), CreateConfigurableFile(), CTmpEnvironmentSetter::CTmpEnvironmentSetter(), CTrackingEnvHolder::CTrackingEnvHolder(), FindBlastDbPath(), CSampleLibraryObject::FindInPath(), CNcbiApplicationAPI::FindProgramExecutablePath(), CProjBulderApp::GenerateMsvcProjects(), CCgiSampleApplication::GetCdVersion(), CDBEnvConnParams::GetDatabaseName(), CArgDescDefault::GetDefaultValue(), CDBEnvConnParams::GetPassword(), CDBEnvConnParams::GetServerName(), CDBEnvConnParams::GetUserName(), CSeqTestApplication::Init(), CCgiApplication::LogRequest(), CQueryParseTree::Parse(), CBlastFormat::PrintArchive(), CCgiSampleApplication::ProcessPrintEnvironment(), CNcbiApplogApp::Redirect(), CNcbiApplogApp::Run(), ASNIOTestApp::Run(), CMsvcConfigure::WriteBuildVer(), WriteEnvironment(), CMakeBlastDBApp::x_BuildDatabase(), CEnvironmentRegistry::x_Get(), CCgiRequest::x_GetPropertyByName(), CNcbiTestApplication::x_InitCommonParserVars(), CEnvironmentRegistry::x_Set(), and CEnvironmentRegistry::x_Unset().

◆ GetErrCodeString() const char * CArgumentsException::GetErrCodeString ( void ) const overridevirtual ◆ GetProgramBasename() ◆ GetProgramDirname() ◆ GetProgramName()

Get program name.

Definition at line 373 of file ncbienv.cpp.

References eIgnoreLinks, CSafeStatic< T, Callbacks >::Get(), NStr::IntToString(), CNcbiArguments::m_Args, CNcbiArguments::m_ProgramName, CNcbiArguments::m_ResolvedName, CNcbiArguments::m_ResolvedNameMutex, and CDirEntry::NormalizePath().

Referenced by CSamplePhoneHomePolicy::Apply(), CCgiStatistics::Compose_ProgramName(), CNcbiApplicationAPI::FindProgramExecutablePath(), CNcbiArguments::GetProgramBasename(), and CNcbiArguments::GetProgramDirname().

◆ Load() ◆ NCBI_EXCEPTION_DEFAULT() ◆ operator=() ◆ operator[]() ◆ Reset() [1/2] void CNcbiEnvironment::Reset ( const char *const * envp = 0 ) ◆ Reset() [2/2] ◆ SEnvValue() [1/2] ◆ SEnvValue() [2/2] CNcbiEnvironment::SEnvValue::SEnvValue ( void ) inline

Definition at line 153 of file ncbienv.hpp.

◆ Set()

Set an environment variable by name.

This will throw an exception if setting the variable fails

Definition at line 147 of file ncbienv.cpp.

References _T_XCSTRING, map_checker< Container >::end(), map_checker< Container >::find(), free(), i, kEmptyXCStr, CNcbiEnvironment::m_Cache, CNcbiEnvironment::m_CacheMutex, NCBI_LSAN_DISABLE_GUARD, NCBI_THROW, NcbiSys_putenv, NcbiSys_strdup, NULL, str(), and rapidjson::value.

Referenced by BOOST_AUTO_TEST_CASE(), CAutoEnvironmentVariable::CAutoEnvironmentVariable(), CTmpEnvironmentSetter::CTmpEnvironmentSetter(), CMapperFormattingArgs::ExtractAlgorithmOptions(), CNcbiApplicationAPI::SetEnvironment(), CNcbiEnvironment::Unset(), CEnvironmentRegistry::x_Set(), CAutoEnvironmentVariable::~CAutoEnvironmentVariable(), and CTmpEnvironmentSetter::~CTmpEnvironmentSetter().

◆ SetProgramName() ◆ Shift() void CNcbiArguments::Shift ( int n = 1 ) ◆ Size() SIZE_TYPE CNcbiArguments::Size ( void ) const inline

Get size (number) of arguments.

Definition at line 265 of file ncbienv.hpp.

References CNcbiArguments::m_Args.

Referenced by CNcbiApplogApp::Cmd_Generate(), CArgDescriptions::CreateArgs(), CCommandArgDescriptions::CreateArgs(), CNcbiApplogApp::PrintTokenInformation(), CCommandArgDescriptions::PrintUsage(), CNcbiApplogApp::Redirect(), CTest::Run(), CTestApplication::Run(), CAdvancedAlignCleanup::SetParams(), CPubseqGatewayApp::x_GetCmdLineArguments(), CNetScheduleHandler::x_ProcessHealth(), and CCgiRequest::x_ProcessQueryString().

◆ Unset()

Delete an environment variable by name.

Parameters: name environment variable name [in]

Definition at line 176 of file ncbienv.cpp.

References _ASSERT, map_checker< Container >::end(), map_checker< Container >::erase(), map_checker< Container >::find(), free(), i, kEmptyStr, kEmptyXCStr, CNcbiEnvironment::m_Cache, CNcbiEnvironment::m_CacheMutex, NULL, CNcbiEnvironment::Set(), and unsetenv.

Referenced by CAutoEnvironmentVariable::CAutoEnvironmentVariable(), CEnvironmentCleaner::Clean(), CEnvironmentRegistry::x_Unset(), and CAutoEnvironmentVariable::~CAutoEnvironmentVariable().

◆ ~CAutoEnvironmentVariable() CAutoEnvironmentVariable::~CAutoEnvironmentVariable ( ) ◆ ~CNcbiArguments() CNcbiArguments::~CNcbiArguments ( void ) virtual ◆ ~CNcbiEnvironment() CNcbiEnvironment::~CNcbiEnvironment ( void ) virtual ◆ m_Args deque<string> CNcbiArguments::m_Args private ◆ m_Cache TCache CNcbiEnvironment::m_Cache mutableprivate ◆ m_CacheMutex ◆ m_Env ◆ m_PrevValue string CAutoEnvironmentVariable::m_PrevValue private ◆ m_ProgramName string CNcbiArguments::m_ProgramName private ◆ m_ResolvedName string CNcbiArguments::m_ResolvedName mutableprivate ◆ m_ResolvedNameMutex ◆ m_VariableName string CAutoEnvironmentVariable::m_VariableName private ◆ m_WasSet bool CAutoEnvironmentVariable::m_WasSet private ◆ ptr ◆ value

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4