SE PutDataTableData

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

extern SE_Return_Code
SE_PutDataTableData
(
	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)
const	SE_Data_Table_Data	*	data_table_data_ptr	(notes)
);

Definition

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

Returns

SE_RET_CODE_SUCCESS and the data is stored in the tranmittal.

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

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.

SE_STAT_CODE_INVALID_ACCESS_MODE set if data_table belongs to a transmittal that was opened in read-only mode.

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

the given element_indices does not form a valid <Data Table> signature,

<Data Table> doesn't belong to an open transmittal,

<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

data_table

 the <Data Table> whose cell data is inserted.

extents_ptr

 indicates the cells to be inserted.

element_count

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

element_indices

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

data_table_data_ptr

 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 the
 <Data Table>.

SE_RET_CODE_SUCCESS	and the data is stored in the tranmittal.
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.
SE_STAT_CODE_INVALID_ACCESS_MODE	set if data_table belongs to a transmittal that was opened in read-only mode.
SE_STAT_CODE_INACTIONABLE_FAILURE	set if the call fails for any other reason including: the given element_indices does not form a valid <Data Table> signature, <Data Table> doesn't belong to an open transmittal, <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>),