SEDRIS Reference Manual
APPENDIX B - Transmittal Access Level 1 API
Functions
SE GetDataTableConstantSignature
extern SE_Status_Code
SE_GetDataTableConstantSignature
(
SE_Object data_table,1
SE_Integer_Unsigned *constant_element_count_out_ptr,2
SE_Table_Property_Description_Fields **prop_array_out_ptr,3
EDCS_Attribute_Value **constant_value_array_out_ptr4
);

Definition

Retrieves the <Table Property Description> components of the <Data Table> instance that are of constant value throughout the table, calculates the constant_element_count, and retrieves the arrays used to specify the constant <Property Characteristic> instances.

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


Returns

SE_STATCODE_SUCCESS and the output parameters are allocated and set to the appropriate values, if valid parameters were passed in and all operations succeed.
SE_STATCODE_UNRESOLVED_INPUT_OBJECT and no changes are made, if data_table is an unresolved DRM object.
SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT and no changes are made, if an unresolved object was encountered and could not be resolved.
SE_STATCODE_NO_OBJECT and no changes are made, if the <Data Table> has no <Table Property Description> components of constant value.
SE_STATCODE_INACTIONABLE_FAILURE and no changes are made, if
  1. an invalid <Table Property Description> or <Property Characteristic> is encountered, or
  2. the call fails for any other reason.

Parameters Notes

1 the <Data Table> whose signature is being retrieved

2 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)

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

4 pointer to an array of constant_element_count <Property Characteristic> values


Prev: SE_FreeDataTableSubExtent. Next: SE_GetDataTableSignature. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS