SEDRIS Reference Manual
APPENDIX B - Transmittal Access Level 1 API
Functions
SE GetDataTableSignature
extern SE_Status_Code
SE_GetDataTableSignature
(
SE_Object data_table, (notes)
SE_Integer_Unsigned *element_count_out_ptr, (notes)
SE_Table_Property_Description_Fields **prop_array_out_ptr, (notes)
SE_Integer_Positive **table_prop_descript_number_out_ptr (notes)
);

Definition

Retrieves the <Table Property Descriptions> of the <Data Table>, calculates the element_count per cell, and retrieves the arrays used to specify selected elements and components.

Memory allocated by this function should be freed via SE_FreeDataTableSignature().


Returns

SE_STAT_CODE_SUCCESS and the output parameters are set to the appropriate values, if valid parameters were passed in and all operations succeed.
SE_STAT_CODE_UNRESOLVED_INPUT_OBJECT and no changes are made, if data_table is an unresolved SEDRIS object.
SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT and no changes are made, if an unresolved object was encountered and could not be resolved.
SE_STAT_CODE_INACTIONABLE_FAILURE and no changes are made, if the call fails for any other reason.


Parameters Notes


data_table

 the <Data Table> instance whose signature is being retrieved.

element_count_out_ptr

 pointer to a variable in the user's memory
    space, which is set to the number of elements per cell
    (and which is also the size of the 3 arrays that follow).

prop_array_out_ptr

 pointer to an array of element_count
    <Table Property Description> fields, one for each
    element of a cell.

table_prop_descript_number_out_ptr

 pointer to
    the array of indices into the ordered list of
    <Table Property Descriptions> aggregated by data_table, where
    the array is being allocated and retrieved by this function


Prev: SE_GetDataTableConstantSignature. Next: SE_GetDataTableSubExtent. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS