carb::acquireFrameworkAndRegisterBuiltins

Defined in carb/ClientUtils.h

inline Framework *carb::acquireFrameworkAndRegisterBuiltins(const OmniCoreStartArgs *args = nullptr)

Main acquisition of the Carbonite Framework for Clients (applications and plugins).

At a high level, this function:

• Calls carb::acquireFramework() and assigns it to a global variable within this module: g_carbFramework.

• Calls logging::registerLoggingForClient(), assert::registerAssertForClient(), and l10n::registerLocalizationForClient().

• Calls OMNI_CORE_START().

Warning

It is typically not necessary to call this, since macros such as OMNI_CORE_INIT already ensure that this function is called properly.

Parameters

args – Arguments passed to OMNI_CORE_START

Returns

A pointer to the Carbonite Framework, if initialization was successful; nullptr otherwise.