SE AllocDataTableData

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE AllocDataTableData

extern SE_Return_Code
SE_AllocDataTableData
(
	SE_Object			data_table,	(notes)
const	SE_Data_Table_Sub_Extent		*	extents_ptr,	(notes)
	SE_Integer_Positive			element_count,	(notes)
const	SE_Integer_Positive			element_indices[],	(notes)
	SE_Store			store_in,	(notes)
	SE_Data_Table_Data	*	*	data_table_data_ptr	(notes)
);

Definition

This function is used to allocate the memory associated with the cell data of a <Data Table> instance. It is provided as a convenience function for users who are inserting data into the <Data Table> instance. The memory allocated is managed by the SE_Store passed into this function.

Returns

SE_RET_CODE_SUCCESS	and the requested memory is allocated
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS set upon successful completion.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

data_table

 the <Data Table> object whose cell data are being allocated

extents_ptr

 indicates the cells that the user wants allocated
 (which 'region' of the <Data Table> to insert).

element_count

 the number of elements per cell to allocate

element_indices

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

store_in

 The store that is used to manage the allocated memory.

data_table_data_ptr

 pointer to a pointer to a block of memory allocated by
    this function to hold the <Data Table>. Freeing this block
    of memory is the caller's (i.e., ultimately the user's)
    responsibility.