Function Name: Get Data Table Extents

Definition

Allocates and initializes the start and stop arrays for extents, and computes the number of cells in the table. Memory allocated by this function should be freed via SE_FreeDataTableExtents().

Returns

SE_SUCCESS - if valid parameters were passed in and all operations succeeded. In this case, *extents_ptr is allocated and the output parameters are initialized to the appropriate values.

SE_NULL_REQUIRED_PARAMETER - if extents_ptr or cell_count_ptr is NULL. In this case, the output parameters are left unaltered.

SE_INVALID_OR_NULL_OBJECT - if data_table is not a valid . In this case, extents_ptr->axes_count is set to zero (0), its pointer fields are set to NULL, and *cell_count_ptr is set to zero (0).

SE_UNRESOLVED_START_OBJECT - if data_table is an unresolved SEDRIS object. The out parameters are set as for SE_INVALID_OR_NULL_OBJECT in this case.

SE_UNRESOLVED_OBJECT - if an unresolved object was encountered and could not be resolved. The out parameters are set as for SE_INVALID_OR_NULL_OBJECT in this case.

SE_OUT_OF_MEMORY - if memory allocation fails. In this case, the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetDataTableExtents
(
SE_OBJECT data_table, (notes)
SE_DATA_TABLE_EXTENTS *extents_ptr, (notes)
SE_UINT32 *cell_count_ptr (notes)
);

Parameters Notes

data_table

 <Data Table> whose extents are being found

extents_ptr

 pointer to extents whose stop_array and start_array are
 allocated and initialized here

cell_count_ptr

 pointer to a variable in the user's memory space, which is set
 to the number of cells in the <Data Table>
Prev: Get Data Table Constant Signature. Next: Get Data Table Max Extents. Up:Index.