SE FreePackedDataTableDataStrings

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

extern SE_Status_Code
SE_FreePackedDataTableDataStrings
(
	SE_Object		data_table,	(notes)
const	SE_Data_Table_Sub_Extent	*	extents_ptr,	(notes)
	SE_Integer_Unsigned		element_count,	(notes)
const	SE_Integer_Positive		table_prop_descript_number[],	(notes)
	unsigned char	*	data_out_ptr,	(notes)
	void	(dealloc_func_ptr)(char )	(notes)
);

Definition

Frees memory for a <Data Table> that was allocated by SE_GetPackedDataTable(), i.e. frees any strings within the data.

Returns

SE_STAT_CODE_SUCCESS and the output parameters are set to appropriate values, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and the output parameter values are left unaltered, if

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

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and no changes are made, if data_table is not a handle to a valid, active (i.e., unfreed) <Data Table> instance.

SE_STAT_CODE_FAILURE and no changes are made, if

extents' size is bad
one of the entries in table_prop_descript_number doesn't correspond to a <Table Property Description>
the type of one of the selected elements is invalid.

Parameters Notes

data_table

 <Data Table> whose strings are being freed; needed, with
    the table_prop_descript_numbers, to find the locations of
    strings in data_out_ptr.

extents_ptr

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

element_count

 the number of elements per cell; also the size of the
     table_prop_descript_number array, below.

table_prop_descript_number

 an array of indices into the ordered list of
    <Table Property Descriptions> aggregated by the
    <Data Table>.

data_out_ptr

 pointer to block of memory allocated to hold the cells
    of a <Data Table>.

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_GetPackedDataTable().  For example, if SE_AllocString() was used,
    then SE_FreeString() must be used (see DRM API).

SE_STAT_CODE_SUCCESS	and the output parameters are set to appropriate values, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and the output parameter values are left unaltered, if data_out_ptr is NULL, or element_count is zero, table_prop_descript_number is NULL, extents_ptr is NULL, dealloc_func_ptr is NULL,
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and no changes are made, if data_table is not a handle to a valid, active (i.e., unfreed) <Data Table> instance.
SE_STAT_CODE_FAILURE	and no changes are made, if extents' size is bad one of the entries in table_prop_descript_number doesn't correspond to a <Table Property Description> the type of one of the selected elements is invalid.