acquireFrameworkForBindings#

Fully qualified name: carb::acquireFrameworkForBindings

Defined in carb/BindingsUtils.h

inline Framework *carb::acquireFrameworkForBindings(

const char *scriptLanguage,

)#

Acquires the Carbonite Framework for a script binding.

See also

Framework::registerScriptBinding()

Note

This is automatically called by FrameworkInitializerForBindings::FrameworkInitializerForBindings() from CARB_BINDINGS().

Parameters:

scriptLanguage – The script language that this binding works with (i.e. “python”). This binding is registered as via carb::getFramework()->registerScriptBinding(BindingType::Binding, g_carbClientName, scriptLanguage).

Returns:

A pointer to the Carbonite Framework, or nullptr on error (i.e. version mismatch).