SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetDataTableData
extern SE_Return_Code
SE_GetDataTableData
(
SE_Object data_table_object,1
constSE_Data_Table_Sub_Extent *extents,2
SE_Integer_Positive element_count,3
constSE_Integer_Positive element_indices[],4
SE_Store store,5
SE_Data_Table_Data **data6
);

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. For example, in order to access the ith cell of the jth float element the following syntax would be used:

data[j].dt_array_union.float_array[i]


Returns

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

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if valid parameters were passed in and all operations successfully completed.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT set if data_table_object is an unresolved object (see SE_Object's comments for details on how this condition occurs).
SE_STATCODE_C_STORE_INVALID set if store is not a handle to a valid SE_Store.
SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any other reason, including:
  1. the extents pointed to by extents are invalid,
  2. any of the element_indices entries are invalid for data_table_object, or are not unique within the array,
  3. data_table_object is a <Property Grid> instance with a data_present field set to SE_FALSE,
  4. data_table_object has been created via the API but has not yet had the cell data added to it.

Parameters Notes

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

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

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

4 an array of indices into the ordered list of <Table Property Description> instances aggregated by data_table_object.

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

6 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.


Prev: SE_GetDRMClass. Next: SE_GetEncoding. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS