Function Name: Get Size Of Element Of Data Table

Definition

Computes the number of bytes needed in order to store a section of the Data Table of a single element with 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_GetElementOfDataTable().

Returns

SE_SUCCESS - if valid parameters were passed in. In this case, the output parameter is set to the appropriate value.

SE_NULL_REQUIRED_PARAMETER - the output parameter is left unaltered, if

  1. byte_count_out_ptr was NULL,
  2. extents_ptr was NULL.

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

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.

SE_FAILURE - *byte_count_out_ptr is set to zero (0), if

  1. if the extents are invalid for the <Data Table>, or
  2. if the element, component pair is not present in the <Data Table>

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetSizeOfElementOfDataTable
(
SE_OBJECT data_table, (notes)
constSE_DATA_TABLE_EXTENTS *extents_ptr, (notes)
EDCS_AC_ID element, (notes)
EDCS_CC_ID component, (notes)
SE_UINT32 *byte_count_out_ptr (notes)
);

Parameters Notes

data_table

 the <Data Table> object.

extents_ptr

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

element

 a single EDCS Attribute Code (EAC), indicating which element
 should returned from each cell.

component

 if element == EDCS_AC_INDEX_TO_COMPONENT or
 EDCS_AC_INDEX_TO_LIBRARY, used to distinguish which component or
 library <Data Table> should be used; otherwise, component is ignored

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 region
 of the <Data Table> will be stored.

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