SE FreeStateSelectParameters

SEDRIS Reference Manual APPENDIX C - LEVEL 0 READ and WRITE API AUXILIARY FUNCTIONS Functions SE FreeStateSelectParameters

extern SE_Status_Code
SE_FreeStateSelectParameters
(
SE_State_Select_Parameters	*	to_free,	(notes)
void	(dealloc_func_in_ptr)(void )	(notes)
);

Definition

Frees any internal pointers in use within the given structure. Intended for use with SE_CloneStateSelectParameters().

Returns

SE_STAT_CODE_SUCCESS and the data is freed, if a valid parameter was passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and to_free is left unchanged, if to_free is NULL.

Parameters Notes

to_free

 pointer to the SE_State_Select_Parameters whose
    internal pointers (if in use) are to be freed.

dealloc_func_in_ptr

 pointer to a user-supplied function to
    be used to free the memory. Must correspond to the function used to
    allocate the memory. (Should be omitted if
    SE_CloneStateSelectParameters() was used.)

SE_STAT_CODE_SUCCESS	and the data is freed, if a valid parameter was passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and to_free is left unchanged, if to_free is NULL.