SE_state_get_base_info

Retrieves information about a state by ID, without retrieving the state&#\146;s lineage information

Usage syntax

LONG SE_state_get_base_info (SE_CONNECTION connection, LONG state_id, SE_STATEINFO state);

Parameters
connection The connection handle
state_id The state ID
state Pointer to a location to receive the SE_STATEINFO definition
Description

SE_state_get_base_info obtains the definition of a specific state as identified by its ID. Use SE_BASE_STATE_ID in the state_id parameter to retrieve the root of the state tree. Information about the state is returned to the caller in an SE_STATEINFO object. The SE_STATEINFO object used as an argument to this function must be be a valid object created by SE_stateinfo_create.

SE_state_get_base_info differs from SE_state_get_info in that SE_state_get_base_info does not obtain the state’s lineage. Using this function rather than SE_state_get_info is more efficient if the lineage is not needed. Calling SE_stateinfo_get_lineage or SE_stateinfo_get_parent using the the SE_STATEINFO returned from this function will return SE_STATEOBJECT_HAS_NO_LINEAGE.

Returns

SE_SUCCESS
SE_DB_IO_ERROR

SE_INVALID_STATE_ID

SE_INVALID_STATEINFO_OBJECT

SE_NET_FAILURE

SE_STATE_NOEXIST

SE_TABLE_NOEXIST