SE FreeDataTableDataStrings

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

extern SE_Status_Code
SE_FreeDataTableDataStrings
(
const	SE_Data_Table_Sub_Extent	*	extents_ptr,	(notes)
	SE_Integer_Positive		element_count,	(notes)
	SE_Property_Data_Value	*	data_out_ptr,	(notes)
	void	(dealloc_func_ptr)(char )	(notes)
);

Definition

Frees memory allocated by SE_GetDataTable(), i.e., frees any strings within the data.

Returns

SE_STAT_CODE_SUCCESS and memory is deallocated using the function indicated by dealloc_func_ptr, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER no changes are made, if

extents_ptr is NULL,
element_count is zero,
data_out_ptr is NULL, or
dealloc_func_ptr is NULL.

SE_STAT_CODE_FAILURE and no changes are made, if extents_ptr is invalid.

Parameters Notes

extents_ptr

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

element_count

 the number of elements per cell.

data_out_ptr

 pointer to block of memory that holds 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 in
    SE_GetDataTable().  If SE_AllocString() was used, then SE_FreeString()
    must be used (see DRM API).

SE_STAT_CODE_SUCCESS	and memory is deallocated using the function indicated by dealloc_func_ptr, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	no changes are made, if extents_ptr is NULL, element_count is zero, data_out_ptr is NULL, or dealloc_func_ptr is NULL.
SE_STAT_CODE_FAILURE	and no changes are made, if extents_ptr is invalid.