SE FreeDataQualityElement

The SEDRIS Data Representation Model APPENDIX D - Functions SE FreeDataQualityElement

extern SE_DRM_Status_Code
SE_FreeDataQualityElement
(
SE_Data_Quality_Element	*	to_free,	(notes)
void	(dealloc_func_in_ptr)(void )	(notes)
);

Definition

Frees any internal pointers in the data in the given SE_Data_Quality_Element structure.

IMPORTANT NOTE: This function is intended only for use with SE_CloneDataQualityElement(), if dealloc_func_in_ptr is not specified.

IMPORTANT NOTE:	This function is intended only for use with SE_CloneDataQualityElement(), if dealloc_func_in_ptr is not specified.

Returns

SE_DRM_STAT_CODE_SUCCESS	and internal pointers within the data of *to_free are freed and set to NULL, and any corresponding "array size" fields are set to zero (0), if valid parameters were passed in.
SE_DRM_STAT_CODE_NULL_REQUIRED_PARAMETER	and *to_free is left unchanged, if to_free is NULL.

Parameters Notes

to_free

 pointer to the SE_Data_Quality_Element whose internal pointer(s)
    (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_CloneDataQualityElement() was used.)