scpt_get_bag

March 26, 2020 Contributors

Name

scpt_get_bag — Returns the environmental "bag" associated with the current callout

Synopsis

#include "modules/scriptlets/ec_scriptlet.h"

| ec_bag * **scpt_get_bag** ( | thr); |   |

scpt_thread * <var class="pdparam">thr</var>;

Description

**Configuration Change. ** This feature is available starting from Momentum 3.1.

This function returns the environmental "bag" associated with the current callout.

This function is intended to be called in the context of "thr" while it is executing. It does not add a reference to the bag.

Parameters

thr

The script thread. For a description of this data type see “scpt_thread”.

Return Value

This function returns an ec_bag. For a description of this data type see “ec_bag”.

Threading

It is legal to call this function in any thread.

See Also

Chapter 42, Scriptlet (and Alerting) Functions