Configuration (C++)

group FnConfig

class Foundry::Katana::Config

#include <FnConfig.h>

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

Public Functions

virtual ~Config()

Public Static Functions

static bool has(const std::string &key)

Parameters

key – The key of the configuration entry to be queried.

Returns

True if there is an entry with the given key, otherwise false.

static std::string get(const std::string &key)

Parameters

key – The 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 void exportConfiguration(std::map<std::string, std::string> &exportedConfig)

Parameters

exportedConfig – A map that will be filled with the keys and values stored in the configuration.

static const FnConfigHostSuite_v1 *getSuite()

static FnPluginStatus setHost(FnPluginHost *host)