Function Name: Get Data Table Max Extents

Definition

Returns the upper bounds of the <Data Table> extents of the given Data Table.

Returns

SE_SUCCESS - if valid parameters were passed in and all operations succeeded. In this case, *stop_array_ptr is allocated and the output parameters are set to the appropriate values.

SE_NULL_REQUIRED_PARAMETER - if axes_count_ptr or stop_array_ptr are NULL. In this case, the output parameter values are left unaltered.

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

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

SE_OUT_OF_MEMORY if memory could not be allocated. In this case, the output parameters are set as for SE_INVALID_OR_NULL_OBJECT.

SE_FAILURE - the output parameters are set as for SE_INVALID_OR_NULL_OBJECT in this case, if

  1. an Axis or its fields could not be retrieved, or
  2. a degenerate Axis was encountered.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetDataTableMaxExtents
(
SE_OBJECT data_table, (notes)
SE_UINT16 *axes_count_ptr, (notes)
SE_UINT16 **stop_array_ptr (notes)
);

Parameters Notes

data_table

 the <Data Table> whose maximum extents are desired

axes_count_ptr

 a pointer to a variable in the user's memory space
 where the number of axes for the <Data Table> will be stored. This
 is also the number of entries allocated in *stop_array_ptr.

stop_array_ptr

 a pointer to a variable in the user's memory space
 where an array of SE_UINT16's will be allocated and set to the
 maximum stop values.  It is the *user's* responsibility to free
 this array when the user is finished with it.

Prev: Get Data Table Extents. Next: Get Data Table Signature. Up:Index.