scpt_compile_callout

March 26, 2020 Contributors

Name

scpt_compile_callout — Compile and register a scriptlet entrypoint

Synopsis

#include "modules/scriptlets/ec_scriptlet.h"

| scpt_callout * **scpt_compile_callout** ( | name, |   |
|   | rettype, |   |
|   | params); |   |

const char * <var class="pdparam">name</var>;
const char * <var class="pdparam">rettype</var>;
const char * <var class="pdparam">params</var>;

Description

Compile and register a scriptlet entrypoint.

The entrypoint is defined in terms of the C function that it represents. Once registered, the function can be implemented by a scriptlet and will be bound as part of the scriptlet register_module call.

Parameters

name

The name of the callout.

rettype

The return type of the callout.

params

The parameters.

Return Value

This function returns a pointer to a scpt_callout. For a description of this data type see “scpt_callout”.

Only a limited subset of return values are supported; if an unsupported return type is encountered, the entry point will fail to compile and this function will return NULL.

The returned entrypoint can be used as a helper to invoke a corresponding method in a scriptlet table.

Threading

It is legal to call this function in any thread.

See Also

Chapter 42, Scriptlet (and Alerting) Functions