SE GetDataTableConstantSignature

SEDRIS Reference Manual APPENDIX B - LEVEL 1 READ and WRITE API Functions SE GetDataTableConstantSignature

extern SE_Status_Code
SE_GetDataTableConstantSignature
(
SE_Object			data_table,	(notes)
SE_Integer_Unsigned		*	constant_element_count_out_ptr,	(notes)
SE_Table_Property_Description_Fields	*	*	prop_array_out_ptr,	(notes)
SE_Property_Data_Value	*	*	constant_value_array_out_ptr	(notes)
);

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_STAT_CODE_SUCCESS and the output parameters are allocated and 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 constant_element_count_out_ptr or constant_value_array_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *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, if data_table is not a handle to a valid, active, (i.e., not freed) <Data Table> instance.

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

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

SE_STAT_CODE_NO_OBJECT and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if the <Data Table> has no <Table Property Descriptions> of constant value.

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

SE_STAT_CODE_FAILURE and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if

an invalid <Table Property Description> or <Property Characteristic> is encountered, or

the API implementation specified does not provide the necessary underlying functions in its shared library, and dynamic binding is specified at compile time.

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

SE_STAT_CODE_SUCCESS	and the output parameters are allocated and 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 constant_element_count_out_ptr or constant_value_array_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and 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, if data_table is not a handle to a valid, active, (i.e., not freed) <Data Table> instance.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if data_table is an unresolved SEDRIS object.
SE_STAT_CODE_UNRESOLVED_OBJECT	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if an unresolved object was encountered and could not be resolved.
SE_STAT_CODE_NO_OBJECT	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if the <Data Table> has no <Table Property Descriptions> of constant value.
SE_STAT_CODE_OUT_OF_MEMORY	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if memory allocation fails.
SE_STAT_CODE_FAILURE	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if an invalid <Table Property Description> or <Property Characteristic> is encountered, or the API implementation specified does not provide the necessary underlying functions in its shared library, and dynamic binding is specified at compile time.