SE GetDataTableSubExtent

SEDRIS Reference Manual APPENDIX B - LEVEL 1 READ and WRITE API Functions SE GetDataTableSubExtent

extern SE_Status_Code
SE_GetDataTableSubExtent
(
SE_Object		data_table,	(notes)
SE_Data_Table_Sub_Extent	*	extents_ptr,	(notes)
SE_Integer_Unsigned	*	cell_count_ptr	(notes)
);

Definition

Allocates and initializes the axes_bounds array for extents, and computes the number of cells in the table. Memory allocated by this function should be freed via SE_FreeDataTableSubExtent().

Returns

SE_STAT_CODE_SUCCESS and *extents_ptr is allocated and the output parameters are initialized to the appropriate values, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and the output parameters are left unaltered, if extents_ptr or cell_count_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and extents_ptr->axes_count is set to zero (0), its pointer field is set to NULL, and *cell_count_ptr is set to zero (0), if data_table is not a valid instance.

SE_STAT_CODE_UNRESOLVED_START_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if data_table is an unresolved SEDRIS object.

SE_STAT_CODE_UNRESOLVED_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if an unresolved object was encountered and could not be resolved.

SE_STAT_CODE_OUT_OF_MEMORY and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if memory could not be allocated.

SE_STAT_CODE_FAILURE and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if

an <Axis> or its fields could not be retrieved,

an invalid <Axis> was encountered,

the API implementation specified does not provide the necessary underlying functions in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

data_table

 <Data Table> whose extents are being found

extents_ptr

 pointer to extents whose axes_bounds array is
    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>

SE_STAT_CODE_SUCCESS	and *extents_ptr is allocated and the output parameters are initialized to the appropriate values, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and the output parameters are left unaltered, if extents_ptr or cell_count_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and extents_ptr->axes_count is set to zero (0), its pointer field is set to NULL, and *cell_count_ptr is set to zero (0), if data_table is not a valid instance.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if data_table is an unresolved SEDRIS object.
SE_STAT_CODE_UNRESOLVED_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if an unresolved object was encountered and could not be resolved.
SE_STAT_CODE_OUT_OF_MEMORY	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if memory could not be allocated.
SE_STAT_CODE_FAILURE	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if an <Axis> or its fields could not be retrieved, an invalid <Axis> was encountered, the API implementation specified does not provide the necessary underlying functions in its shared library, and dynamic binding is specified at compile time.