scpt_push_object

March 26, 2020 Contributors

Name

scpt_push_object — Box a C structure to pass into a scriptlet routine

Synopsis

#include "modules/scriptlets/ec_scriptlet.h"

| void **scpt_push_object** ( | thr, |   |
|   | objtype, |   |
|   | object); |   |

scpt_thread * <var class="pdparam">thr</var>;
const char * <var class="pdparam">objtype</var>;
void * <var class="pdparam">object</var>;

Description

Box a C structure to pass into a scriptlet routine.

Parameters

thr

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

objtype

The object type.

object

A pointer to the object.

Return Value

This function returns void.

Threading

It is legal to call this function in any thread.

See Also

Chapter 42, Scriptlet (and Alerting) Functions and scpt_push_object2