Main Page   Compound List   File List   Compound Members   File Members  

HC_Sequence.c File Reference

#include <stdio.h>
#include <string.h>
#include <malloc.h>
#include "checkpoint_int.h"

Functions

int HC_CallSequence (HC_Sequence_t *sequence, void *userdata, long start_node)
HC_Sequence_t * HC_NewSequence (HC_NodelistNode_t *nodelist)
void HC_DeleteSequence (HC_Sequence_t *sequence)

Detailed Description

Collection of functions relating to sequences.

Function Documentation

int HC_CallSequence (  HC_Sequence_t *    sequence,
void *    userdata,
long    start_node
) 
 

Execution of a sequence starts here. The sequence starts by running the Normal function for the start_node given.

Parameters:
sequence  The sequence object, created by HC_NewSequence().
userdata  User defined data. It is passed to all user functions.
start_node  The first executed node.
Returns:
An error code (or HC_OK)

void HC_DeleteSequence (  HC_Sequence_t *    sequence ) 
 

Deletes a sequence, cleanups up any memory, etc. The sequence pointer is invalid after this call.

Parameters:
sequence  A sequence object

HC_Sequence_t* HC_NewSequence (  HC_NodelistNode_t *    nodelist ) 
 

Creates a sequence object from nodelist.

Parameters:
nodelist  A table of nodes and functions to be executed by the sequence.
Returns:
A sequence object containing the nodelist data given.

Copyright ©2003. Astra Network Inc. All Rights Reserved.