SE GetSizeOfDataTableData

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

extern SE_Status_Code
SE_GetSizeOfDataTableData
(
	SE_Object		data_table,	(notes)
const	SE_Data_Table_Sub_Extent	*	extents_ptr,	(notes)
	SE_Integer_Positive		element_count,	(notes)
const	SE_Integer_Positive		table_prop_descript_number[],	(notes)
	SE_Integer_Unsigned	*	byte_count_out_ptr	(notes)
);

Definition

Computes the number of bytes needed in order to store the region of the <Data Table> specified by the given axis extents.

This function can be used to determine how much space to allocate for a call to the level 0 API function SE_GetDataTable().

Returns

SE_STAT_CODE_SUCCESS and *byte_count_out_ptr is set to the appropriate value, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *byte_count_out_ptr is left unaltered, if

extents_ptr is NULL, or

element_count is zero (0),

table_prop_descript_number is NULL, or
byte_count_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *byte_count_out_ptr is set to zero (0), if data_table is not a handle to a valid, active (i.e., unfreed) <Data Table> instance.

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

SE_STAT_CODE_UNRESOLVED_OBJECT and *byte_count_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if an unresolved object was encountered and could not be resolved.

SE_STAT_CODE_FAILURE and *byte_count_out_ptr is set to zero (0), if

the extents are invalid for data_table,

table_prop_descript_number is invalid for data_table, or

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

 the <Data Table> object being evaluated.

extents_ptr

 indicates the cells that the user wants returned
    (which 'region' of the <Data Table> is to be retrieved).

element_count

 the number of elements per cell to return, and the
    size of the table_prop_descript_number array

table_prop_descript_number

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

byte_count_out_ptr

 a pointer to a variable in the user's memory space
    where the number of bytes needed to store the specified sub-table
    of the <Data Table> will be stored.

SE_STAT_CODE_SUCCESS	and *byte_count_out_ptr is set to the appropriate value, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *byte_count_out_ptr is left unaltered, if extents_ptr is NULL, or element_count is zero (0), table_prop_descript_number is NULL, or byte_count_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *byte_count_out_ptr is set to zero (0), if data_table is not a handle to a valid, active (i.e., unfreed) <Data Table> instance.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and the output parameter is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if data_table is an unresolved SEDRIS object.
SE_STAT_CODE_UNRESOLVED_OBJECT	and *byte_count_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if an unresolved object was encountered and could not be resolved.
SE_STAT_CODE_FAILURE	and *byte_count_out_ptr is set to zero (0), if the extents are invalid for data_table, table_prop_descript_number is invalid for data_table, or the API implementation specified does not provide the necessary underlying functions in its shared library, and dynamic binding is specified at compile time.