Katana Plug-in APIs 0.1
Static Public Member Functions

Foundry::Katana::Config Class Reference

#include <FnConfig.h>

List of all members.

Static Public Member Functions

static bool has (const std::string &key)
static std::string get (const std::string &key)
static void exportConfiguration (std::map< std::string, std::string > &exportedConfig)

Detailed Description

Provides a number of static methods to access the configuration of the currently running Katana session.


Member Function Documentation

static void Foundry::Katana::Config::exportConfiguration ( std::map< std::string, std::string > &  exportedConfig) [static]
Parameters:
exportedConfigA map that will be filled with the keys and values stored in the configuration.
static std::string Foundry::Katana::Config::get ( const std::string &  key) [static]
Parameters:
keyThe key of the configuration entry whose value to retrieve.
Returns:
The value of a configuration entry with the given key, or an empty string if no entry exists with the given key.
static bool Foundry::Katana::Config::has ( const std::string &  key) [static]
Parameters:
keyThe key of the configuration entry to be queried.
Returns:
True if there is an entry with the given key, otherwise false.

The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator