SE GetDataTableSignature

SEDRIS Reference Manual APPENDIX B - LEVEL 1 READ and WRITE 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_NULL_REQUIRED_PARAMETER and no changes are made, if

element_count_out_ptr is NULL, or
table_prop_descript_number_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *element_count_out_ptr is set to zero, *table_prop_descript_number_out_ptr is set to NULL, and *prop_array_out_ptr is set to NULL if provided, if data_table is not a valid <Data Table>.

SE_STAT_CODE_OUT_OF_MEMORY and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if memory allocation failed.

SE_STAT_CODE_UNRESOLVED_START_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if data_table is an unresolved SEDRIS object.

SE_STAT_CODE_UNRESOLVED_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if an unresolved object was encountered and could not be resolved.

SE_STAT_CODE_FAILURE and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if fields can't be retrieved for a <Table Property Description>.

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

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_NULL_REQUIRED_PARAMETER	and no changes are made, if element_count_out_ptr is NULL, or table_prop_descript_number_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and element_count_out_ptr is set to zero, table_prop_descript_number_out_ptr is set to NULL, and *prop_array_out_ptr is set to NULL if provided, if data_table is not a valid <Data Table>.
SE_STAT_CODE_OUT_OF_MEMORY	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if memory allocation failed.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if data_table is an unresolved SEDRIS object.
SE_STAT_CODE_UNRESOLVED_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if an unresolved object was encountered and could not be resolved.
SE_STAT_CODE_FAILURE	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if fields can't be retrieved for a <Table Property Description>.