1.2.2 PRIME_Initialize Function

C

SYS_MODULE_OBJ PRIME_Initialize
(
  const SYS_MODULE_INDEX index,
  const SYS_MODULE_INIT * init
)

Summary

Initializes the PRIME Stack for the specified index.

Description

This routine initializes the PRIME Stack making it ready for clients to use.

Precondition

None.

Parameters


Param	Description
index	Identifier for the instance to be initialized (single instance allowed)
init	Pointer to the init data structure containing any data necessary to initialize the module.

Returns

If successful, returns a valid module instance object. Otherwise, returns SYS_MODULE_OBJ_INVALID.

Example

PRIME_STACK_INIT initData;
SYS_MODULE_OBJ sysObjPrime;

sysObjPrime = PRIME_Initialize(PRIME_INDEX_0, (SYS_MODULE_INIT *)&initData);
if (sysObjPrime == SYS_MODULE_OBJ_INVALID)
{

}

Remarks

This routine must be called before any other PRIME routine is called.