Function Name: Get Data Table Constant Signature

Definition

Retrieves the Table Property Descriptions of the Data Table that are of constant value throughout the table, calculates the constant_element_count, and retrieves the arrays used to specify the constant Property Characteristics.

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

Returns

SE_NULL_REQUIRED_PARAMETER - and no changes are made, if constant_element_count_out_ptr or constant_value_array_out_ptr is NULL.

SE_INVALID_OR_NULL_OBJECT - if data_table is not a handle to a valid, active, (i.e., not freed) Data Table. In this case *constant_element_count_out_ptr is set to zero, *constant_value_array_out_ptr is set to NULL, and *prop_array_out_ptr is set to NULL if provided.

SE_UNRESOLVED_START_OBJECT - and the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case, if data_table is an unresolved SEDRIS object.

SE_UNRESOLVED_OBJECT - and the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case, if an unresolved object was encountered and could not be resolved.

SE_NO_OBJECT - and the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case, if the Data Table has no Table Property Descriptions of constant value.

SE_OUT_OF_MEMORY - and the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case, if memory allocation fails.

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

1. data_table is not part of the composition tree of a Transmittal Root
2. the search filter or component iterator can't be created
3. an invalid Table Property Description or Property Characteristic is encountered

Prototype

Parameters Notes

data_table

 the <Data Table> whose signature is being retrieved

constant_element_count_out_ptr

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

prop_array_out_ptr

 pointer to an array of constant_element_count <Table Property Description>
 fields, one for each constant element of a table

constant_value_array_out_ptr

 pointer to an array of constant_element_count <Property Characteristic>
 values