|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE AllocDataTableData |
|---|
| extern SE_Return_Code | |||||
| SE_AllocDataTableData | |||||
| ( | |||||
| 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 | ||
| SE_Store | store_in, | 5 | |||
| SE_Data_Table_Data | * | * | data_table_data_ptr | 6 | |
| ); | |||||
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.
| SE_RETCOD_SUCCESS | and the requested memory is allocated |
| SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set upon successful completion. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_C_STORE_INVALID | set if store_in is not a handle to a valid SE_Store. |
| SE_STATCODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
1 the <Data Table> object whose cell data are being allocated
2 indicates the cells that the user wants allocated (which 'region' of the <Data Table> to insert).
3 the number of elements per cell to allocate
4 an array of indices into the ordered list of <Table Property Description> components of data_table.
5 the store that is used to manage the allocated memory.
6 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.
Prev: SE_AddComponentRelationship.
Next: SE_CloneObjectHandle.
Up:Index.
|