source/classes/inc/mh5program.h File Reference

Implement the MHEG5 Program Class Defines means to handle execution of external pieces of procedural code. More...

#include "mh5ingredient.h"

Go to the source code of this file.

Data Structures
struct	MHEG5Program_struct
Typedefs
typedef struct MHEG5Program_struct	MHEG5Program
Functions
void	MHEG5residentProgramInit (MHEG5Program *program)
	<Function description>="">
void	MHEG5residentProgramFree (MHEG5Program *program)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5remoteProgramInit (MHEG5Program *program)
	Initialise a remoteProgram object with default values.
void	MHEG5remoteProgramFree (MHEG5Program *program)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5interchangedProgramInit (MHEG5Program *program)
	Initialise a interchangedProgram object with default values.
void	MHEG5interchangedProgramFree (MHEG5Program *program)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5programPrepare (MHEG5Program *program)
MHEG5ErrorCode	MHEG5programActivate (MHEG5Program *program)
void	MHEG5programDeactivate (MHEG5Program *program)
void	MHEG5programDestruct (MHEG5Program *program)
void	MHEG5programFree (MHEG5Program *program)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
MHEG5ErrorCode	MHEG5call (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5fork (MHEG5Root *target, MHEG5GList *params)

---

Detailed Description

Implement the MHEG5 Program Class Defines means to handle execution of external pieces of procedural code.

Date:

22/01/2002

Author:

iwillis

---

Function Documentation

void MHEG5interchangedProgramFree

(

MHEG5Program *

program

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

program

Pointer to object to free.

Returns:

Void

void MHEG5interchangedProgramInit

(

MHEG5Program *

program

)

Initialise a interchangedProgram object with default values.

Parameters:

program

Pointer to object to initialise.

Returns:

Void

void MHEG5programFree

(

MHEG5Program *

program

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

program

Pointer to object to free.

Returns:

Void

void MHEG5remoteProgramFree

(

MHEG5Program *

program

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

program

Pointer to object to free.

Returns:

Void

void MHEG5remoteProgramInit

(

MHEG5Program *

program

)

Initialise a remoteProgram object with default values.

Parameters:

program

Pointer to object to initialise.

Returns:

Void

void MHEG5residentProgramFree

(

MHEG5Program *

program

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

program

Pointer to object to free.

Returns:

Void

void MHEG5residentProgramInit

(

MHEG5Program *

program

)

<Function description>="">

Returns:

<Return value>=""> Initialise a residentProgram object with default values.

Parameters:

program

Pointer to object to initialise.

Returns:

Void

<Function description>="">

Parameters:

program

Pointer to object to initialise.

Returns:

Void