SE FreeElementOfDataTableDataStrings

SEDRIS Reference Manual APPENDIX B - LEVEL 1 READ and WRITE API Functions SE FreeElementOfDataTableDataStrings

extern SE_Status_Code
SE_FreeElementOfDataTableDataStrings
(
const	SE_Data_Table_Sub_Extent	*	extents_ptr,	(notes)
	SE_Property_Data_Value_Ptr	*	data_out_ptr,	(notes)
	void	(dealloc_func_ptr)(char )	(notes)
);

Definition

Frees any dynamically allocated memory within *data_out_ptr's internal array, although not the internal array itself.

WARNING: Under no circumstances should this function ever be called for a *data_out_ptr whose memory is being managed by a store.

WARNING:	Under no circumstances should this function ever be called for a *data_out_ptr whose memory is being managed by a store.

Returns

SE_STAT_CODE_SUCCESS and frees any strings within the block pointed to by data_out_ptr, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and no changes are made, if
extents_ptr is NULL,

data_out_ptr is NULL, or

dealloc_func_ptr is NULL.

SE_STAT_CODE_FAILURE and no changes are made, if

*extent_ptr is invalid, or

*data_out_ptr is invalid.

Parameters Notes

extents_ptr

 indicates the cells that the user wanted (the 'region' of
    of the <Data Table> that was returned).

data_out_ptr

 pointer to structure containing a pointer to a block of
    memory allocated to hold the <Data Table>'s data

dealloc_func_ptr

 pointer to a user-supplied function to use to free
    strings; must correspond to the function used to allocate strings
    when the cells of the <Data Table> were created

SE_STAT_CODE_SUCCESS	and frees any strings within the block pointed to by data_out_ptr, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and no changes are made, if extents_ptr is NULL, data_out_ptr is NULL, or dealloc_func_ptr is NULL.
SE_STAT_CODE_FAILURE	and no changes are made, if extent_ptr is invalid, or data_out_ptr is invalid.