SE_stateinfo_get_lineage

Retrieves the lineage of a state as an array.

Usage syntax

LONG SE_stateinfo_get_lineage (const SE_STATEINFO state, LONG **lineage, LONG *count);

Parameters
state The state handle
lineage Address of a pointer in a dynamically allocated space that will contain an variable length array of state IDs
count The number of state IDs in the lineage
Description

SE_stateinfo_get_lineage returns a variable length array of state IDs that comprise a state's lineage. The lineage includes an ordered list of the state IDs. The total number of IDs is returned in the count parameter. The application must free the lineage to reclaim the memory allocated by this function with SE_stateinfo_free array.

Returns

SE_SUCCESS
SE_INVALID_POINTER

SE_INVALID_STATEINFO_OBJECT

SE_NET_FAILURE

SE_OUT_OF_CLMEM

SE_SDE_NOT_STARTED