SE GetDataTableData

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

extern SE_Return_Code
SE_GetDataTableData
(
	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_out_ptr	(notes)
);

Definition

This function is used to retrieve cell data of a <Data Table > instance. Based on the extents and elements specifed, the function will retrieve and copy the requested data into the memory provided through * data_table_data_out_ptr. For example, in order to access the ith cell of the jth float element the following syntax would be used:

data_table_data_out_ptr[j].dt_array_union.float_array[i]

Returns

SE_RET_CODE_SUCCESS and the requested data is returned, if valid parameters were passed in and all operations succeeded.

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 if valid parameters were passed in and all operations successfully completed.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT set if data_table is an unresolved object (see SE_Object's comments for details on how this condition occurs).

SE_STAT_CODE_INACTIONABLE_FAILURE set if the call fails for any other reason, including:

the extents pointed to by extents_ptr are invalid,

any of the element_indices entries are invalid for data_table, or are not unique within the array,

data_table is a <Property Grid> with a data_present field set to SE_FALSE,

data_table has been created via the API but has not yet had cells added to it.

Parameters Notes

data_table

 the <Data Table> object whose cells are being retrieved.

extents_ptr

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

element_count

 the number of elements per cell to return which will
 indicate the size of the element_indices and
 data_table_data_out_ptr arrays.

element_indices

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

store_in

 a handle to a store; the API allocates memory for the requested
    data within this store.

data_table_data_out_ptr

 a pointer to an array of SE_Data_Table_Data structures. The API
 allocates memory for the requested data and copies it into these
 structures.

SE_RET_CODE_SUCCESS	and the requested data is returned, if valid parameters were passed in and all operations succeeded.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.

SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT	set if data_table is an unresolved object (see SE_Object's comments for details on how this condition occurs).
SE_STAT_CODE_INACTIONABLE_FAILURE	set if the call fails for any other reason, including: the extents pointed to by extents_ptr are invalid, any of the element_indices entries are invalid for data_table, or are not unique within the array, data_table is a <Property Grid> with a data_present field set to SE_FALSE, data_table has been created via the API but has not yet had cells added to it.