sym_get_warm_start

warm_start_desc *sym_get_warm_start(sym_environment *env, int copy_warm_start,
warm_start_desc **ws)

Description:

This routine is used to get the warm start description loaded to the environment.

Arguments:

sym_environment *env IN Pointer to the SYMPHONY environment.
int copy_warm_start IN A boolean indicating whether the warm start of the environment is desired to be copied or overtaken.
warm_start_desc **ws OUT Pointer to a pointer to be directed to a copy or the itself of the currently loaded warm start.

Return values:

FUNCTION_TERMINATED_NORMALLY Function invoked successfully.
FUNCTION_TERMINATED_ABNORMALLY Function invoked unsuccessfully.