20.7 freem_kill()

Deletes a FreeM local node, global node, or killable SSV node, as well as all of its children.

short freem_kill(freem_ref_t *ref);

Parameters

freem_ref_t

This parameter is a pointer to a freem_ref_t struct. The caller must allocate the memory for this struct.

Return Value

Returns OK on success, or one of the other error values defined in merr.h.

Example

#include <stdio.h>
#include <string.h>
#include <freem.h>

int main(int argc, char **argv, char **envp)
{
    freem_ref_t ref;

    /* we're killing a global node */
    ref.reftype = MREF_RT_GLOBAL;

    /* access global "car" */
    strcpy(ref.name, "car");

    /* set up the subscripts */
    ref.subscript_count = 0;

    /* use the USER namespace */
    freem_init("USER");

    /* kill the global and all its descendant subscripts */
    freem_kill(&ref);    
}

This document was generated by root on October 14, 2020 using texi2html 1.82.