SE GetSizeOfPackedDataTableData

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

extern SE_Status_Code
SE_GetSizeOfPackedDataTableData
(
	SE_Object		data_table,	(notes)
const	SE_Data_Table_Sub_Extent	*	extents_ptr,	(notes)
	SE_Integer_Unsigned		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 section of data_table specified by the given extents and signature, in a packed fashion.

Returns

SE_STAT_CODE_SUCCESS and *byte_count_out_ptr is set appropriately, 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,

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 not altered, if data_table is not a handle to a valid, active (i.e., not freed) <Data Table> instance.

SE_STAT_CODE_FAILURE *byte_count_out_ptr is not affected, 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> instance

extents_ptr

 indicates the cells that the user wants returned (which
    'region' of data_table is to be retrieved)

element_count

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

table_prop_descript_number

 an array of indices into the ordered list
    of <Table Property Description> instances 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 section of
    data_table in a packed fashion will be placed

SE_STAT_CODE_SUCCESS	and *byte_count_out_ptr is set appropriately, 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, 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 not altered, if data_table is not a handle to a valid, active (i.e., not freed) <Data Table> instance.
SE_STAT_CODE_FAILURE	*byte_count_out_ptr is not affected, 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.