SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE PutDataTableData
extern SE_Return_Code
SE_PutDataTableData
(
SE_Object  data_table,1
const SE_Data_Table_Sub_Extent  *extents_ptr,2
SE_Integer_Positive  element_count,3
const SE_Integer_Positive  element_indices[],4
const SE_Data_Table_Data  *data_table_data_ptr5
);

Definition

This function is used to insert the cell data of a given <Data Table>.


Returns

SE_RETCOD_SUCCESS and the data is stored in the transmittal.
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 succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT set if data_table is an unresolved object.
SE_STATCODE_INVALID_ACCESS_MODE set if data_table belongs to a transmittal that was opened in read-only mode.
SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any other reason including:
  1. the given element_indices does not form a valid <Data Table> signature,
  2. <Data Table> doesn't belong to an open transmittal,
  3. <Data Table> is a <Property Grid> with data_present set to SE_FALSE (note that the default value of this field is SE_TRUE, if the user has not yet set the fields of the <Property Grid>),

Parameters Notes

1 the <Data Table> whose cell data is inserted.

2 indicates the cells to be inserted.

3 the number of elements per cell to insert, and the size of the element_indices array.

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

5 a pointer to an array of SE_Data_Table_Data structures, already allocated either in a store or in the user's memory space, to be written to data_table.


Prev: SE_PublishObject. Next: SE_PutFields. Up:Index.