Get Size Of Data Table Data

Function Name: Get Size Of Data Table Data

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_SUCCESS - if valid parameters were passed in. In this case, *byte_count_out_ptr is set to the appropriate value.

SE_NULL_REQUIRED_PARAMETER - the output parameter is left unaltered, if

byte_count_out_ptr is NULL, or
element_count is zero (0), or
extents_ptr is NULL, or
selected_elements is NULL, or
selected_components is NULL but required.

SE_INVALID_OR_NULL_OBJECT - if data_table is not a handle to a valid, active (i.e., unfreed) <Data Table>. In this case, *byte_count_out_ptr is set to zero (0).

SE_FAILURE - *byte_count_out_ptr is set to zero, if

the extents are invalid for the <Data Table>, or
any of the selected_elements, selected_components pairs are not applicable to (contained in) the <Data Table>, or
any of the selected_elements, selected_components pairs are duplicate entries.

SE_UNRESOLVED_START_OBJECT - if data_table is an unresolved SEDRIS object. The output parameter is 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 output parameter is set as for SE_INVALID_OR_NULL_OBJECT in this case.

Prototype

extern SE_STATUS_CODE_ENUM
SE_GetSizeOfDataTableData
(
	SE_OBJECT		data_table,	(notes)
const	SE_DATA_TABLE_EXTENTS	*	extents_ptr,	(notes)
	SE_UINT32		element_count,	(notes)
const	EDCS_AC_ID		selected_elements[],	(notes)
const	EDCS_CC_ID		selected_components[],	(notes)
	SE_UINT32	*	byte_count_out_ptr	(notes)
);

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 following selected_elements, selected_components arrays.

selected_elements

 an array of EDCS Attribute Codes (EACs), indicating which
 elements should be returned for each cell, *and* defining how
 those elements should be ordered when they are returned.

selected_components

   an array of EDCS Classification Codes (ECCs); selected_components[i]
   is ignored unless selected_elements[i] == EDCS_AC_INDEX_TO_COMPONENT
   or EDCS_AC_INDEX_TO_LIBRARY, in which case selected_components[i] is
   used to distinguish multiple EDCS_AC_INDEX_TO_COMPONENT and/or
   EDCS_AC_INDEX_TO_LIBRARY entries.
         In other words, selected_components is a required parameter if
      selected_elements has any EDCS_AC_INDEX_TO_COMPONENT and/or
      EDCS_AC_INDEX_TO_LIBRARY entries; otherwise, it is an optional
      parameter.

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.

Prev: Get Rearranged Image Data. Next: Get Size Of Element Of Data Table. Up:Index.