scpt_push_object_and_allocate

March 26, 2020 Contributors

Name

scpt_push_object_and_allocate — Allocate room to hold a boxed C structure of a particular type

Synopsis

#include "modules/scriptlets/ec_scriptlet.h"

| void * **scpt_push_object_and_allocate** ( | thr, |   |
|   | objtype, |   |
|   | objsize); |   |

scpt_thread * <var class="pdparam">thr</var>;
const char * <var class="pdparam">objtype</var>;
size_t <var class="pdparam">objsize</var>;

Description

Allocate room to hold a boxed C structure of a particular type.

This is intended to be used by the generated glue code only.

Parameters

thr

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

objtype

The object type.

objsize

The object size.

Return Value

This function returnsa pointer to the object.

Threading

It is legal to call this function in any thread.

See Also

Chapter 42, Scriptlet (and Alerting) Functions